From 23091dfdbf0b1f5434903b992d4e55296c4a4125 Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" Date: Wed, 23 Feb 2022 10:07:24 +0000 Subject: [PATCH] Regenerate client from commit c049b6d of spec repo (#542) Co-authored-by: ci.datadog-api-spec f66f0141b0d3751bbb219e08e4f17474fff4ee85 --- classes/v1.APIErrorResponse.html | 2 +- classes/v1.AWSAccount.html | 22 +- classes/v1.AWSAccountAndLambdaRequest.html | 4 +- classes/v1.AWSAccountCreateResponse.html | 2 +- classes/v1.AWSAccountDeleteRequest.html | 6 +- classes/v1.AWSAccountListResponse.html | 2 +- classes/v1.AWSIntegrationApi.html | 18 +- classes/v1.AWSLogsAsyncError.html | 4 +- classes/v1.AWSLogsAsyncResponse.html | 4 +- classes/v1.AWSLogsIntegrationApi.html | 14 +- classes/v1.AWSLogsLambda.html | 2 +- classes/v1.AWSLogsListResponse.html | 6 +- classes/v1.AWSLogsListServicesResponse.html | 4 +- classes/v1.AWSLogsServicesRequest.html | 4 +- classes/v1.AWSTagFilter.html | 2 +- classes/v1.AWSTagFilterCreateRequest.html | 4 +- classes/v1.AWSTagFilterDeleteRequest.html | 4 +- classes/v1.AWSTagFilterListResponse.html | 2 +- classes/v1.AlertGraphWidgetDefinition.html | 8 +- classes/v1.AlertValueWidgetDefinition.html | 10 +- classes/v1.ApiException.html | 2 +- classes/v1.ApiKey.html | 8 +- classes/v1.ApiKeyAuthAuthentication.html | 6 +- classes/v1.ApiKeyAuthQueryAuthentication.html | 6 +- classes/v1.ApiKeyListResponse.html | 2 +- classes/v1.ApiKeyResponse.html | 2 +- classes/v1.ApmStatsQueryColumnType.html | 6 +- classes/v1.ApmStatsQueryDefinition.html | 12 +- classes/v1.AppKeyAuthAuthentication.html | 6 +- classes/v1.AppKeyAuthQueryAuthentication.html | 6 +- classes/v1.ApplicationKey.html | 6 +- classes/v1.ApplicationKeyListResponse.html | 2 +- classes/v1.ApplicationKeyResponse.html | 2 +- classes/v1.AuthZAuthentication.html | 6 +- classes/v1.AuthenticationApi.html | 2 +- .../v1.AuthenticationValidationResponse.html | 2 +- classes/v1.AzureAccount.html | 16 +- classes/v1.AzureIntegrationApi.html | 10 +- classes/v1.BaseServerConfiguration.html | 4 +- classes/v1.CancelDowntimesByScopeRequest.html | 2 +- classes/v1.CanceledDowntimesIds.html | 2 +- classes/v1.ChangeWidgetDefinition.html | 10 +- classes/v1.ChangeWidgetRequest.html | 10 +- classes/v1.CheckCanDeleteMonitorResponse.html | 2 +- .../v1.CheckCanDeleteMonitorResponseData.html | 2 +- classes/v1.CheckCanDeleteSLOResponse.html | 2 +- classes/v1.CheckCanDeleteSLOResponseData.html | 2 +- classes/v1.CheckStatusWidgetDefinition.html | 14 +- classes/v1.Creator.html | 6 +- classes/v1.Dashboard.html | 28 +- classes/v1.DashboardBulkActionData.html | 4 +- classes/v1.DashboardBulkDeleteRequest.html | 2 +- classes/v1.DashboardDeleteResponse.html | 2 +- classes/v1.DashboardList.html | 14 +- classes/v1.DashboardListDeleteResponse.html | 2 +- classes/v1.DashboardListListResponse.html | 2 +- classes/v1.DashboardListsApi.html | 10 +- classes/v1.DashboardRestoreRequest.html | 2 +- classes/v1.DashboardSummary.html | 2 +- classes/v1.DashboardSummaryDefinition.html | 16 +- classes/v1.DashboardTemplateVariable.html | 8 +- .../v1.DashboardTemplateVariablePreset.html | 4 +- ....DashboardTemplateVariablePresetValue.html | 4 +- classes/v1.DashboardsApi.html | 14 +- classes/v1.DeletedMonitor.html | 2 +- classes/v1.DistributionWidgetDefinition.html | 14 +- classes/v1.DistributionWidgetRequest.html | 4 +- classes/v1.DistributionWidgetXAxis.html | 8 +- classes/v1.DistributionWidgetYAxis.html | 10 +- classes/v1.Downtime.html | 30 +- classes/v1.DowntimeChild.html | 30 +- classes/v1.DowntimeRecurrence.html | 12 +- classes/v1.DowntimesApi.html | 14 +- classes/v1.Event.html | 22 +- classes/v1.EventCreateRequest.html | 18 +- classes/v1.EventCreateResponse.html | 2 +- classes/v1.EventListResponse.html | 4 +- classes/v1.EventQueryDefinition.html | 4 +- classes/v1.EventResponse.html | 2 +- classes/v1.EventStreamWidgetDefinition.html | 10 +- classes/v1.EventTimelineWidgetDefinition.html | 10 +- classes/v1.EventsApi.html | 6 +- ...tionApmDependencyStatsQueryDefinition.html | 18 +- ...nctionApmResourceStatsQueryDefinition.html | 18 +- ...ormulaAndFunctionEventQueryDefinition.html | 8 +- ...ndFunctionEventQueryDefinitionCompute.html | 4 +- ...AndFunctionEventQueryDefinitionSearch.html | 2 +- ...1.FormulaAndFunctionEventQueryGroupBy.html | 6 +- ...rmulaAndFunctionEventQueryGroupBySort.html | 4 +- ...rmulaAndFunctionMetricQueryDefinition.html | 4 +- ...mulaAndFunctionProcessQueryDefinition.html | 12 +- classes/v1.FreeTextWidgetDefinition.html | 8 +- classes/v1.FunnelQuery.html | 4 +- classes/v1.FunnelStep.html | 4 +- classes/v1.FunnelWidgetDefinition.html | 8 +- classes/v1.FunnelWidgetRequest.html | 2 +- classes/v1.GCPAccount.html | 26 +- classes/v1.GCPIntegrationApi.html | 8 +- classes/v1.GeomapWidgetDefinition.html | 10 +- classes/v1.GeomapWidgetDefinitionStyle.html | 4 +- classes/v1.GeomapWidgetDefinitionView.html | 2 +- classes/v1.GeomapWidgetRequest.html | 8 +- classes/v1.GraphSnapshot.html | 6 +- classes/v1.GroupWidgetDefinition.html | 10 +- classes/v1.HTTPLogError.html | 4 +- classes/v1.HTTPLogItem.html | 10 +- classes/v1.HeatMapWidgetDefinition.html | 16 +- classes/v1.HeatMapWidgetRequest.html | 4 +- classes/v1.Host.html | 24 +- classes/v1.HostListResponse.html | 6 +- classes/v1.HostMapRequest.html | 4 +- classes/v1.HostMapWidgetDefinition.html | 18 +- .../v1.HostMapWidgetDefinitionRequests.html | 2 +- classes/v1.HostMapWidgetDefinitionStyle.html | 8 +- classes/v1.HostMeta.html | 28 +- classes/v1.HostMetaInstallMethod.html | 6 +- classes/v1.HostMetrics.html | 6 +- classes/v1.HostMuteResponse.html | 8 +- classes/v1.HostMuteSettings.html | 6 +- classes/v1.HostTags.html | 4 +- classes/v1.HostTotals.html | 4 +- classes/v1.HostsApi.html | 8 +- classes/v1.HourlyUsageAttributionBody.html | 16 +- .../v1.HourlyUsageAttributionMetadata.html | 2 +- .../v1.HourlyUsageAttributionPagination.html | 2 +- .../v1.HourlyUsageAttributionResponse.html | 2 +- classes/v1.HttpException.html | 2 +- classes/v1.IFrameWidgetDefinition.html | 2 +- classes/v1.IPPrefixesAPI.html | 4 +- classes/v1.IPPrefixesAPM.html | 4 +- classes/v1.IPPrefixesAgents.html | 4 +- classes/v1.IPPrefixesLogs.html | 4 +- classes/v1.IPPrefixesProcess.html | 4 +- classes/v1.IPPrefixesSynthetics.html | 8 +- classes/v1.IPPrefixesWebhooks.html | 4 +- classes/v1.IPRanges.html | 6 +- classes/v1.IPRangesApi.html | 2 +- classes/v1.IdpFormData.html | 2 +- classes/v1.IdpResponse.html | 2 +- classes/v1.ImageWidgetDefinition.html | 10 +- classes/v1.IntakePayloadAccepted.html | 2 +- classes/v1.IsomorphicFetchHttpLibrary.html | 2 +- classes/v1.KeyManagementApi.html | 20 +- classes/v1.ListStreamColumn.html | 4 +- classes/v1.ListStreamQuery.html | 4 +- classes/v1.ListStreamWidgetDefinition.html | 12 +- classes/v1.ListStreamWidgetRequest.html | 4 +- classes/v1.Log.html | 2 +- classes/v1.LogContent.html | 12 +- classes/v1.LogQueryDefinition.html | 8 +- classes/v1.LogQueryDefinitionGroupBy.html | 6 +- classes/v1.LogQueryDefinitionGroupBySort.html | 6 +- classes/v1.LogQueryDefinitionSearch.html | 2 +- classes/v1.LogStreamWidgetDefinition.html | 18 +- classes/v1.LogsAPIError.html | 6 +- classes/v1.LogsAPIErrorResponse.html | 2 +- classes/v1.LogsApi.html | 4 +- classes/v1.LogsArithmeticProcessor.html | 12 +- classes/v1.LogsAttributeRemapper.html | 18 +- classes/v1.LogsByRetention.html | 4 +- classes/v1.LogsByRetentionMonthlyUsage.html | 4 +- classes/v1.LogsByRetentionOrgUsage.html | 2 +- classes/v1.LogsByRetentionOrgs.html | 2 +- classes/v1.LogsCategoryProcessor.html | 10 +- classes/v1.LogsCategoryProcessorCategory.html | 2 +- classes/v1.LogsDateRemapper.html | 8 +- classes/v1.LogsExclusion.html | 4 +- classes/v1.LogsExclusionFilter.html | 4 +- classes/v1.LogsFilter.html | 2 +- classes/v1.LogsGeoIPParser.html | 10 +- classes/v1.LogsGrokParser.html | 10 +- classes/v1.LogsGrokParserRules.html | 4 +- classes/v1.LogsIndex.html | 10 +- classes/v1.LogsIndexListResponse.html | 2 +- classes/v1.LogsIndexUpdateRequest.html | 8 +- classes/v1.LogsIndexesApi.html | 12 +- classes/v1.LogsIndexesOrder.html | 2 +- classes/v1.LogsListRequest.html | 10 +- classes/v1.LogsListRequestTime.html | 6 +- classes/v1.LogsListResponse.html | 6 +- classes/v1.LogsLookupProcessor.html | 14 +- classes/v1.LogsMessageRemapper.html | 8 +- classes/v1.LogsPipeline.html | 12 +- classes/v1.LogsPipelineProcessor.html | 8 +- classes/v1.LogsPipelinesApi.html | 14 +- classes/v1.LogsPipelinesOrder.html | 2 +- classes/v1.LogsQueryCompute.html | 6 +- classes/v1.LogsRetentionAggSumUsage.html | 8 +- classes/v1.LogsRetentionSumUsage.html | 8 +- classes/v1.LogsServiceRemapper.html | 8 +- classes/v1.LogsStatusRemapper.html | 8 +- classes/v1.LogsStringBuilderProcessor.html | 12 +- classes/v1.LogsTraceRemapper.html | 8 +- classes/v1.LogsURLParser.html | 12 +- classes/v1.LogsUserAgentParser.html | 12 +- classes/v1.MetricMetadata.html | 14 +- classes/v1.MetricSearchResponse.html | 2 +- classes/v1.MetricSearchResponseResults.html | 2 +- classes/v1.MetricsApi.html | 12 +- classes/v1.MetricsListResponse.html | 4 +- classes/v1.MetricsPayload.html | 2 +- classes/v1.MetricsQueryMetadata.html | 26 +- classes/v1.MetricsQueryResponse.html | 18 +- classes/v1.MetricsQueryUnit.html | 10 +- classes/v1.Monitor.html | 24 +- ...ormulaAndFunctionEventQueryDefinition.html | 8 +- ...ndFunctionEventQueryDefinitionCompute.html | 4 +- ...AndFunctionEventQueryDefinitionSearch.html | 2 +- ...orFormulaAndFunctionEventQueryGroupBy.html | 6 +- ...rmulaAndFunctionEventQueryGroupBySort.html | 4 +- classes/v1.MonitorGroupSearchResponse.html | 4 +- .../v1.MonitorGroupSearchResponseCounts.html | 4 +- classes/v1.MonitorGroupSearchResult.html | 14 +- classes/v1.MonitorOptions.html | 44 +- classes/v1.MonitorOptionsAggregation.html | 6 +- classes/v1.MonitorSearchResponse.html | 2 +- classes/v1.MonitorSearchResponseCounts.html | 8 +- classes/v1.MonitorSearchResponseMetadata.html | 8 +- classes/v1.MonitorSearchResult.html | 22 +- .../v1.MonitorSearchResultNotification.html | 4 +- classes/v1.MonitorState.html | 2 +- classes/v1.MonitorStateGroup.html | 12 +- .../v1.MonitorSummaryWidgetDefinition.html | 16 +- classes/v1.MonitorThresholdWindowOptions.html | 4 +- classes/v1.MonitorThresholds.html | 12 +- classes/v1.MonitorUpdateRequest.html | 24 +- classes/v1.MonitorsApi.html | 18 +- classes/v1.MonthlyUsageAttributionBody.html | 14 +- .../v1.MonthlyUsageAttributionMetadata.html | 4 +- .../v1.MonthlyUsageAttributionPagination.html | 2 +- .../v1.MonthlyUsageAttributionResponse.html | 2 +- classes/v1.MonthlyUsageAttributionValues.html | 60 +-- classes/v1.NoteWidgetDefinition.html | 14 +- classes/v1.NotebookAbsoluteTime.html | 6 +- classes/v1.NotebookAuthor.html | 18 +- classes/v1.NotebookCellCreateRequest.html | 2 +- classes/v1.NotebookCellResponse.html | 4 +- classes/v1.NotebookCellUpdateRequest.html | 4 +- classes/v1.NotebookCreateData.html | 2 +- classes/v1.NotebookCreateDataAttributes.html | 6 +- classes/v1.NotebookCreateRequest.html | 2 +- ...v1.NotebookDistributionCellAttributes.html | 2 +- classes/v1.NotebookHeatMapCellAttributes.html | 2 +- .../v1.NotebookLogStreamCellAttributes.html | 2 +- .../v1.NotebookMarkdownCellAttributes.html | 2 +- .../v1.NotebookMarkdownCellDefinition.html | 4 +- classes/v1.NotebookMetadata.html | 6 +- classes/v1.NotebookRelativeTime.html | 2 +- classes/v1.NotebookResponse.html | 2 +- classes/v1.NotebookResponseData.html | 4 +- .../v1.NotebookResponseDataAttributes.html | 10 +- classes/v1.NotebookSplitBy.html | 4 +- .../v1.NotebookTimeseriesCellAttributes.html | 2 +- classes/v1.NotebookToplistCellAttributes.html | 2 +- classes/v1.NotebookUpdateData.html | 2 +- classes/v1.NotebookUpdateDataAttributes.html | 6 +- classes/v1.NotebookUpdateRequest.html | 2 +- classes/v1.NotebooksApi.html | 10 +- classes/v1.NotebooksResponse.html | 4 +- classes/v1.NotebooksResponseData.html | 4 +- .../v1.NotebooksResponseDataAttributes.html | 10 +- classes/v1.NotebooksResponseMeta.html | 2 +- classes/v1.NotebooksResponsePage.html | 4 +- classes/v1.Organization.html | 10 +- classes/v1.OrganizationBilling.html | 2 +- classes/v1.OrganizationCreateBody.html | 4 +- classes/v1.OrganizationCreateResponse.html | 2 +- classes/v1.OrganizationListResponse.html | 2 +- classes/v1.OrganizationResponse.html | 2 +- classes/v1.OrganizationSettings.html | 12 +- classes/v1.OrganizationSettingsSaml.html | 2 +- ...ionSettingsSamlAutocreateUsersDomains.html | 4 +- ...nizationSettingsSamlIdpInitiatedLogin.html | 2 +- ...v1.OrganizationSettingsSamlStrictMode.html | 2 +- classes/v1.OrganizationSubscription.html | 2 +- classes/v1.OrganizationsApi.html | 10 +- classes/v1.PagerDutyIntegrationApi.html | 8 +- classes/v1.PagerDutyService.html | 4 +- classes/v1.PagerDutyServiceKey.html | 2 +- classes/v1.PagerDutyServiceName.html | 2 +- classes/v1.Pagination.html | 4 +- classes/v1.ProcessQueryDefinition.html | 8 +- classes/v1.QueryValueWidgetDefinition.html | 16 +- classes/v1.QueryValueWidgetRequest.html | 10 +- classes/v1.RequestContext.html | 8 +- classes/v1.ResponseContext.html | 2 +- classes/v1.ResponseMetaAttributes.html | 2 +- classes/v1.SLOBulkDeleteError.html | 6 +- classes/v1.SLOBulkDeleteResponse.html | 2 +- classes/v1.SLOBulkDeleteResponseData.html | 4 +- classes/v1.SLOCorrection.html | 4 +- classes/v1.SLOCorrectionCreateData.html | 2 +- classes/v1.SLOCorrectionCreateRequest.html | 2 +- ....SLOCorrectionCreateRequestAttributes.html | 14 +- classes/v1.SLOCorrectionListResponse.html | 4 +- classes/v1.SLOCorrectionResponse.html | 2 +- .../v1.SLOCorrectionResponseAttributes.html | 18 +- ...OCorrectionResponseAttributesModifier.html | 6 +- classes/v1.SLOCorrectionUpdateData.html | 2 +- classes/v1.SLOCorrectionUpdateRequest.html | 2 +- ....SLOCorrectionUpdateRequestAttributes.html | 12 +- classes/v1.SLODeleteResponse.html | 4 +- classes/v1.SLOHistoryMetrics.html | 12 +- classes/v1.SLOHistoryMetricsSeries.html | 6 +- .../v1.SLOHistoryMetricsSeriesMetadata.html | 12 +- ...1.SLOHistoryMetricsSeriesMetadataUnit.html | 12 +- classes/v1.SLOHistoryMonitor.html | 24 +- classes/v1.SLOHistoryResponse.html | 2 +- classes/v1.SLOHistoryResponseData.html | 14 +- classes/v1.SLOHistoryResponseError.html | 2 +- .../v1.SLOHistoryResponseErrorWithType.html | 4 +- classes/v1.SLOHistorySLIData.html | 24 +- classes/v1.SLOListResponse.html | 6 +- classes/v1.SLOListResponseMetadata.html | 2 +- classes/v1.SLOListResponseMetadataPage.html | 4 +- classes/v1.SLOResponse.html | 2 +- classes/v1.SLOResponseData.html | 24 +- classes/v1.SLOThreshold.html | 8 +- classes/v1.SLOWidgetDefinition.html | 14 +- classes/v1.ScatterPlotRequest.html | 4 +- classes/v1.ScatterPlotWidgetDefinition.html | 10 +- ...1.ScatterPlotWidgetDefinitionRequests.html | 2 +- classes/v1.ScatterplotTableRequest.html | 6 +- classes/v1.ScatterplotWidgetFormula.html | 4 +- classes/v1.SelfDecodingBody.html | 2 +- classes/v1.Series.html | 12 +- classes/v1.ServerConfiguration.html | 4 +- classes/v1.ServiceCheck.html | 10 +- classes/v1.ServiceChecksApi.html | 2 +- classes/v1.ServiceLevelObjective.html | 22 +- ...1.ServiceLevelObjectiveCorrectionsApi.html | 10 +- classes/v1.ServiceLevelObjectiveQuery.html | 4 +- classes/v1.ServiceLevelObjectiveRequest.html | 14 +- classes/v1.ServiceLevelObjectivesApi.html | 18 +- classes/v1.ServiceMapWidgetDefinition.html | 12 +- .../v1.ServiceSummaryWidgetDefinition.html | 24 +- classes/v1.SlackIntegrationApi.html | 10 +- classes/v1.SlackIntegrationChannel.html | 2 +- .../v1.SlackIntegrationChannelDisplay.html | 8 +- classes/v1.SnapshotsApi.html | 2 +- classes/v1.SunburstWidgetDefinition.html | 12 +- ...1.SunburstWidgetLegendInlineAutomatic.html | 6 +- classes/v1.SunburstWidgetLegendTable.html | 2 +- classes/v1.SunburstWidgetRequest.html | 8 +- classes/v1.SyntheticsAPIStep.html | 12 +- classes/v1.SyntheticsAPITest.html | 14 +- classes/v1.SyntheticsAPITestConfig.html | 6 +- classes/v1.SyntheticsAPITestResultData.html | 12 +- classes/v1.SyntheticsAPITestResultFull.html | 10 +- .../v1.SyntheticsAPITestResultFullCheck.html | 2 +- classes/v1.SyntheticsAPITestResultShort.html | 8 +- ...v1.SyntheticsAPITestResultShortResult.html | 4 +- classes/v1.SyntheticsApi.html | 54 +-- .../v1.SyntheticsApiTestResultFailure.html | 2 +- .../v1.SyntheticsAssertionJSONPathTarget.html | 4 +- ...ntheticsAssertionJSONPathTargetTarget.html | 6 +- classes/v1.SyntheticsAssertionTarget.html | 6 +- classes/v1.SyntheticsBasicAuthNTLM.html | 8 +- classes/v1.SyntheticsBasicAuthSigv4.html | 12 +- classes/v1.SyntheticsBasicAuthWeb.html | 4 +- classes/v1.SyntheticsBatchDetails.html | 2 +- classes/v1.SyntheticsBatchDetailsData.html | 4 +- classes/v1.SyntheticsBatchResult.html | 14 +- classes/v1.SyntheticsBrowserError.html | 8 +- classes/v1.SyntheticsBrowserTest.html | 16 +- classes/v1.SyntheticsBrowserTestConfig.html | 8 +- .../v1.SyntheticsBrowserTestResultData.html | 20 +- ...v1.SyntheticsBrowserTestResultFailure.html | 2 +- .../v1.SyntheticsBrowserTestResultFull.html | 10 +- ....SyntheticsBrowserTestResultFullCheck.html | 2 +- .../v1.SyntheticsBrowserTestResultShort.html | 8 +- ...yntheticsBrowserTestResultShortResult.html | 8 +- classes/v1.SyntheticsBrowserVariable.html | 10 +- classes/v1.SyntheticsCIBatchMetadata.html | 2 +- classes/v1.SyntheticsCIBatchMetadataCI.html | 2 +- classes/v1.SyntheticsCIBatchMetadataGit.html | 4 +- .../v1.SyntheticsCIBatchMetadataPipeline.html | 2 +- .../v1.SyntheticsCIBatchMetadataProvider.html | 2 +- classes/v1.SyntheticsCITest.html | 22 +- classes/v1.SyntheticsCITestBody.html | 2 +- classes/v1.SyntheticsConfigVariable.html | 10 +- classes/v1.SyntheticsCoreWebVitals.html | 6 +- classes/v1.SyntheticsDeleteTestsPayload.html | 2 +- classes/v1.SyntheticsDeleteTestsResponse.html | 2 +- classes/v1.SyntheticsDeletedTest.html | 4 +- classes/v1.SyntheticsDevice.html | 8 +- ...heticsGetAPITestLatestResultsResponse.html | 4 +- ...csGetBrowserTestLatestResultsResponse.html | 4 +- classes/v1.SyntheticsGlobalVariable.html | 12 +- ...v1.SyntheticsGlobalVariableAttributes.html | 2 +- ...theticsGlobalVariableParseTestOptions.html | 4 +- classes/v1.SyntheticsGlobalVariableValue.html | 4 +- ...SyntheticsListGlobalVariablesResponse.html | 2 +- classes/v1.SyntheticsListTestsResponse.html | 2 +- classes/v1.SyntheticsLocation.html | 4 +- classes/v1.SyntheticsLocations.html | 2 +- classes/v1.SyntheticsParsingOptions.html | 6 +- classes/v1.SyntheticsPrivateLocation.html | 8 +- ...heticsPrivateLocationCreationResponse.html | 4 +- ...ationCreationResponseResultEncryption.html | 4 +- .../v1.SyntheticsPrivateLocationSecrets.html | 2 +- ...sPrivateLocationSecretsAuthentication.html | 4 +- ...rivateLocationSecretsConfigDecryption.html | 2 +- classes/v1.SyntheticsSSLCertificate.html | 20 +- .../v1.SyntheticsSSLCertificateIssuer.html | 12 +- .../v1.SyntheticsSSLCertificateSubject.html | 14 +- classes/v1.SyntheticsStep.html | 12 +- classes/v1.SyntheticsStepDetail.html | 28 +- classes/v1.SyntheticsStepDetailWarning.html | 4 +- classes/v1.SyntheticsTestConfig.html | 6 +- classes/v1.SyntheticsTestDetails.html | 16 +- classes/v1.SyntheticsTestOptions.html | 22 +- ...1.SyntheticsTestOptionsMonitorOptions.html | 2 +- classes/v1.SyntheticsTestOptionsRetry.html | 4 +- classes/v1.SyntheticsTestRequest.html | 32 +- .../v1.SyntheticsTestRequestCertificate.html | 2 +- ....SyntheticsTestRequestCertificateItem.html | 6 +- classes/v1.SyntheticsTestRequestProxy.html | 4 +- classes/v1.SyntheticsTiming.html | 18 +- classes/v1.SyntheticsTriggerBody.html | 2 +- .../v1.SyntheticsTriggerCITestLocation.html | 4 +- .../v1.SyntheticsTriggerCITestRunResult.html | 6 +- .../v1.SyntheticsTriggerCITestsResponse.html | 8 +- classes/v1.SyntheticsTriggerTest.html | 2 +- ...yntheticsUpdateTestPauseStatusPayload.html | 2 +- classes/v1.SyntheticsVariableParser.html | 2 +- classes/v1.TableWidgetDefinition.html | 10 +- classes/v1.TableWidgetRequest.html | 16 +- classes/v1.TagToHosts.html | 2 +- classes/v1.TagsApi.html | 10 +- classes/v1.TimeseriesWidgetDefinition.html | 20 +- .../v1.TimeseriesWidgetExpressionAlias.html | 4 +- classes/v1.TimeseriesWidgetRequest.html | 12 +- classes/v1.ToplistWidgetDefinition.html | 10 +- classes/v1.ToplistWidgetRequest.html | 10 +- classes/v1.TreeMapWidgetDefinition.html | 6 +- classes/v1.TreeMapWidgetRequest.html | 8 +- classes/v1.UsageAnalyzedLogsHour.html | 8 +- classes/v1.UsageAnalyzedLogsResponse.html | 2 +- .../v1.UsageAttributionAggregatesBody.html | 6 +- classes/v1.UsageAttributionBody.html | 14 +- classes/v1.UsageAttributionMetadata.html | 4 +- classes/v1.UsageAttributionPagination.html | 10 +- classes/v1.UsageAttributionResponse.html | 2 +- classes/v1.UsageAttributionValues.html | 80 ++-- classes/v1.UsageAuditLogsHour.html | 8 +- classes/v1.UsageAuditLogsResponse.html | 2 +- classes/v1.UsageBillableSummaryBody.html | 14 +- classes/v1.UsageBillableSummaryHour.html | 16 +- classes/v1.UsageBillableSummaryKeys.html | 2 +- classes/v1.UsageBillableSummaryResponse.html | 2 +- classes/v1.UsageCWSHour.html | 10 +- classes/v1.UsageCWSResponse.html | 2 +- ...ageCloudSecurityPostureManagementHour.html | 16 +- ...loudSecurityPostureManagementResponse.html | 2 +- classes/v1.UsageCustomReportsAttributes.html | 10 +- classes/v1.UsageCustomReportsData.html | 4 +- classes/v1.UsageCustomReportsMeta.html | 2 +- classes/v1.UsageCustomReportsPage.html | 2 +- classes/v1.UsageCustomReportsResponse.html | 4 +- classes/v1.UsageDBMHour.html | 10 +- classes/v1.UsageDBMResponse.html | 2 +- classes/v1.UsageFargateHour.html | 10 +- classes/v1.UsageFargateResponse.html | 2 +- classes/v1.UsageHostHour.html | 32 +- classes/v1.UsageHostsResponse.html | 2 +- classes/v1.UsageIncidentManagementHour.html | 8 +- .../v1.UsageIncidentManagementResponse.html | 2 +- classes/v1.UsageIndexedSpansHour.html | 8 +- classes/v1.UsageIndexedSpansResponse.html | 2 +- classes/v1.UsageIngestedSpansHour.html | 8 +- classes/v1.UsageIngestedSpansResponse.html | 2 +- classes/v1.UsageIoTHour.html | 8 +- classes/v1.UsageIoTResponse.html | 2 +- classes/v1.UsageLambdaHour.html | 10 +- classes/v1.UsageLambdaResponse.html | 2 +- classes/v1.UsageLogsByIndexHour.html | 14 +- classes/v1.UsageLogsByIndexResponse.html | 2 +- classes/v1.UsageLogsByRetentionHour.html | 12 +- classes/v1.UsageLogsByRetentionResponse.html | 2 +- classes/v1.UsageLogsHour.html | 20 +- classes/v1.UsageLogsResponse.html | 2 +- classes/v1.UsageMeteringApi.html | 72 ++-- classes/v1.UsageNetworkFlowsHour.html | 8 +- classes/v1.UsageNetworkFlowsResponse.html | 2 +- classes/v1.UsageNetworkHostsHour.html | 8 +- classes/v1.UsageNetworkHostsResponse.html | 2 +- classes/v1.UsageProfilingHour.html | 10 +- classes/v1.UsageProfilingResponse.html | 2 +- classes/v1.UsageRumSessionsHour.html | 14 +- classes/v1.UsageRumSessionsResponse.html | 2 +- classes/v1.UsageRumUnitsHour.html | 10 +- classes/v1.UsageRumUnitsResponse.html | 2 +- classes/v1.UsageSDSHour.html | 10 +- classes/v1.UsageSDSResponse.html | 2 +- classes/v1.UsageSNMPHour.html | 8 +- classes/v1.UsageSNMPResponse.html | 2 +- ...UsageSpecifiedCustomReportsAttributes.html | 12 +- .../v1.UsageSpecifiedCustomReportsData.html | 4 +- .../v1.UsageSpecifiedCustomReportsMeta.html | 2 +- .../v1.UsageSpecifiedCustomReportsPage.html | 2 +- ...1.UsageSpecifiedCustomReportsResponse.html | 2 +- classes/v1.UsageSummaryDate.html | 114 +++--- classes/v1.UsageSummaryDateOrg.html | 116 +++--- classes/v1.UsageSummaryResponse.html | 130 +++--- classes/v1.UsageSyntheticsAPIHour.html | 8 +- classes/v1.UsageSyntheticsAPIResponse.html | 2 +- classes/v1.UsageSyntheticsBrowserHour.html | 8 +- .../v1.UsageSyntheticsBrowserResponse.html | 2 +- classes/v1.UsageSyntheticsHour.html | 8 +- classes/v1.UsageSyntheticsResponse.html | 2 +- classes/v1.UsageTimeseriesHour.html | 12 +- classes/v1.UsageTimeseriesResponse.html | 2 +- classes/v1.UsageTopAvgMetricsHour.html | 6 +- classes/v1.UsageTopAvgMetricsMetadata.html | 6 +- classes/v1.UsageTopAvgMetricsResponse.html | 2 +- classes/v1.User.html | 12 +- classes/v1.UserDisableResponse.html | 2 +- classes/v1.UserListResponse.html | 2 +- classes/v1.UserResponse.html | 2 +- classes/v1.UsersApi.html | 10 +- classes/v1.WebhooksIntegration.html | 8 +- classes/v1.WebhooksIntegrationApi.html | 16 +- .../v1.WebhooksIntegrationCustomVariable.html | 6 +- ...ooksIntegrationCustomVariableResponse.html | 6 +- ...ntegrationCustomVariableUpdateRequest.html | 6 +- .../v1.WebhooksIntegrationUpdateRequest.html | 8 +- classes/v1.Widget.html | 4 +- classes/v1.WidgetAxis.html | 10 +- classes/v1.WidgetConditionalFormat.html | 14 +- classes/v1.WidgetCustomLink.html | 8 +- classes/v1.WidgetEvent.html | 4 +- classes/v1.WidgetFieldSort.html | 4 +- classes/v1.WidgetFormula.html | 8 +- classes/v1.WidgetFormulaLimit.html | 4 +- classes/v1.WidgetLayout.html | 10 +- classes/v1.WidgetMarker.html | 8 +- classes/v1.WidgetRequestStyle.html | 2 +- classes/v1.WidgetStyle.html | 2 +- classes/v1.WidgetTime.html | 2 +- classes/v2.APIErrorResponse.html | 2 +- classes/v2.APIKeyCreateAttributes.html | 2 +- classes/v2.APIKeyCreateData.html | 2 +- classes/v2.APIKeyCreateRequest.html | 2 +- classes/v2.APIKeyRelationships.html | 2 +- classes/v2.APIKeyResponse.html | 2 +- classes/v2.APIKeyUpdateAttributes.html | 2 +- classes/v2.APIKeyUpdateData.html | 4 +- classes/v2.APIKeyUpdateRequest.html | 2 +- classes/v2.APIKeysResponse.html | 4 +- classes/v2.ApiException.html | 2 +- classes/v2.ApiKeyAuthAuthentication.html | 6 +- classes/v2.AppKeyAuthAuthentication.html | 6 +- .../v2.ApplicationKeyCreateAttributes.html | 4 +- classes/v2.ApplicationKeyCreateData.html | 2 +- classes/v2.ApplicationKeyCreateRequest.html | 2 +- classes/v2.ApplicationKeyRelationships.html | 2 +- classes/v2.ApplicationKeyResponse.html | 2 +- .../v2.ApplicationKeyUpdateAttributes.html | 4 +- classes/v2.ApplicationKeyUpdateData.html | 4 +- classes/v2.ApplicationKeyUpdateRequest.html | 2 +- classes/v2.AuthNMapping.html | 6 +- classes/v2.AuthNMappingAttributes.html | 10 +- classes/v2.AuthNMappingCreateAttributes.html | 4 +- classes/v2.AuthNMappingCreateData.html | 2 +- .../v2.AuthNMappingCreateRelationships.html | 2 +- classes/v2.AuthNMappingCreateRequest.html | 2 +- classes/v2.AuthNMappingRelationships.html | 2 +- classes/v2.AuthNMappingResponse.html | 2 +- classes/v2.AuthNMappingUpdateAttributes.html | 4 +- classes/v2.AuthNMappingUpdateData.html | 4 +- .../v2.AuthNMappingUpdateRelationships.html | 2 +- classes/v2.AuthNMappingUpdateRequest.html | 2 +- classes/v2.AuthNMappingsApi.html | 10 +- classes/v2.AuthNMappingsResponse.html | 4 +- classes/v2.AuthZAuthentication.html | 6 +- classes/v2.BaseServerConfiguration.html | 4 +- ...udWorkloadSecurityAgentRuleAttributes.html | 18 +- ...loadSecurityAgentRuleCreateAttributes.html | 8 +- ...udWorkloadSecurityAgentRuleCreateData.html | 2 +- ...orkloadSecurityAgentRuleCreateRequest.html | 2 +- ...oadSecurityAgentRuleCreatorAttributes.html | 4 +- ...v2.CloudWorkloadSecurityAgentRuleData.html | 4 +- ...loudWorkloadSecurityAgentRuleResponse.html | 2 +- ...loadSecurityAgentRuleUpdateAttributes.html | 6 +- ...udWorkloadSecurityAgentRuleUpdateData.html | 2 +- ...orkloadSecurityAgentRuleUpdateRequest.html | 2 +- ...oadSecurityAgentRuleUpdaterAttributes.html | 4 +- ...orkloadSecurityAgentRulesListResponse.html | 2 +- classes/v2.CloudWorkloadSecurityApi.html | 12 +- classes/v2.Creator.html | 6 +- classes/v2.DashboardListAddItemsRequest.html | 2 +- classes/v2.DashboardListAddItemsResponse.html | 2 +- .../v2.DashboardListDeleteItemsRequest.html | 2 +- .../v2.DashboardListDeleteItemsResponse.html | 2 +- classes/v2.DashboardListItem.html | 20 +- classes/v2.DashboardListItemRequest.html | 4 +- classes/v2.DashboardListItemResponse.html | 4 +- classes/v2.DashboardListItems.html | 4 +- .../v2.DashboardListUpdateItemsRequest.html | 2 +- .../v2.DashboardListUpdateItemsResponse.html | 2 +- classes/v2.DashboardListsApi.html | 8 +- classes/v2.FullAPIKey.html | 4 +- classes/v2.FullAPIKeyAttributes.html | 10 +- classes/v2.FullApplicationKey.html | 4 +- classes/v2.FullApplicationKeyAttributes.html | 10 +- classes/v2.HTTPLogError.html | 6 +- classes/v2.HTTPLogErrors.html | 2 +- classes/v2.HTTPLogItem.html | 10 +- classes/v2.HttpException.html | 2 +- classes/v2.IncidentCreateAttributes.html | 10 +- classes/v2.IncidentCreateData.html | 2 +- classes/v2.IncidentCreateRelationships.html | 2 +- classes/v2.IncidentCreateRequest.html | 2 +- ....IncidentFieldAttributesMultipleValue.html | 2 +- ...v2.IncidentFieldAttributesSingleValue.html | 2 +- classes/v2.IncidentNotificationHandle.html | 4 +- classes/v2.IncidentResponse.html | 2 +- classes/v2.IncidentResponseAttributes.html | 36 +- classes/v2.IncidentResponseData.html | 4 +- classes/v2.IncidentResponseMeta.html | 2 +- .../v2.IncidentResponseMetaPagination.html | 6 +- classes/v2.IncidentResponseRelationships.html | 2 +- .../v2.IncidentServiceCreateAttributes.html | 2 +- classes/v2.IncidentServiceCreateData.html | 2 +- classes/v2.IncidentServiceCreateRequest.html | 2 +- classes/v2.IncidentServiceRelationships.html | 2 +- classes/v2.IncidentServiceResponse.html | 2 +- .../v2.IncidentServiceResponseAttributes.html | 6 +- classes/v2.IncidentServiceResponseData.html | 4 +- .../v2.IncidentServiceUpdateAttributes.html | 2 +- classes/v2.IncidentServiceUpdateData.html | 4 +- classes/v2.IncidentServiceUpdateRequest.html | 2 +- classes/v2.IncidentServicesApi.html | 10 +- classes/v2.IncidentServicesResponse.html | 6 +- classes/v2.IncidentTeamCreateAttributes.html | 2 +- classes/v2.IncidentTeamCreateData.html | 2 +- classes/v2.IncidentTeamCreateRequest.html | 2 +- classes/v2.IncidentTeamRelationships.html | 2 +- classes/v2.IncidentTeamResponse.html | 2 +- .../v2.IncidentTeamResponseAttributes.html | 6 +- classes/v2.IncidentTeamResponseData.html | 4 +- classes/v2.IncidentTeamUpdateAttributes.html | 2 +- classes/v2.IncidentTeamUpdateData.html | 4 +- classes/v2.IncidentTeamUpdateRequest.html | 2 +- classes/v2.IncidentTeamsApi.html | 10 +- classes/v2.IncidentTeamsResponse.html | 6 +- ...tTimelineCellMarkdownCreateAttributes.html | 2 +- ...neCellMarkdownCreateAttributesContent.html | 2 +- classes/v2.IncidentUpdateAttributes.html | 18 +- classes/v2.IncidentUpdateData.html | 4 +- classes/v2.IncidentUpdateRelationships.html | 2 +- classes/v2.IncidentUpdateRequest.html | 2 +- classes/v2.IncidentsApi.html | 10 +- classes/v2.IncidentsResponse.html | 6 +- classes/v2.IsomorphicFetchHttpLibrary.html | 2 +- classes/v2.KeyManagementApi.html | 28 +- classes/v2.ListApplicationKeysResponse.html | 4 +- classes/v2.Log.html | 4 +- classes/v2.LogAttributes.html | 14 +- classes/v2.LogsAggregateBucket.html | 4 +- ...gsAggregateBucketValueTimeseriesPoint.html | 4 +- classes/v2.LogsAggregateRequest.html | 6 +- classes/v2.LogsAggregateRequestPage.html | 2 +- classes/v2.LogsAggregateResponse.html | 2 +- classes/v2.LogsAggregateResponseData.html | 2 +- classes/v2.LogsAggregateSort.html | 4 +- classes/v2.LogsApi.html | 8 +- classes/v2.LogsArchive.html | 2 +- classes/v2.LogsArchiveAttributes.html | 10 +- classes/v2.LogsArchiveCreateRequest.html | 2 +- ...v2.LogsArchiveCreateRequestAttributes.html | 8 +- ...v2.LogsArchiveCreateRequestDefinition.html | 2 +- classes/v2.LogsArchiveDefinition.html | 4 +- classes/v2.LogsArchiveDestinationAzure.html | 10 +- classes/v2.LogsArchiveDestinationGCS.html | 6 +- classes/v2.LogsArchiveDestinationS3.html | 6 +- classes/v2.LogsArchiveIntegrationAzure.html | 4 +- classes/v2.LogsArchiveIntegrationGCS.html | 4 +- classes/v2.LogsArchiveIntegrationS3.html | 4 +- classes/v2.LogsArchiveOrder.html | 2 +- classes/v2.LogsArchiveOrderAttributes.html | 2 +- classes/v2.LogsArchiveOrderDefinition.html | 2 +- classes/v2.LogsArchives.html | 2 +- classes/v2.LogsArchivesApi.html | 20 +- classes/v2.LogsCompute.html | 6 +- classes/v2.LogsGroupBy.html | 6 +- classes/v2.LogsGroupByHistogram.html | 6 +- classes/v2.LogsListRequest.html | 2 +- classes/v2.LogsListRequestPage.html | 4 +- classes/v2.LogsListResponse.html | 4 +- classes/v2.LogsListResponseLinks.html | 2 +- classes/v2.LogsMetricCompute.html | 2 +- classes/v2.LogsMetricCreateAttributes.html | 2 +- classes/v2.LogsMetricCreateData.html | 4 +- classes/v2.LogsMetricCreateRequest.html | 2 +- classes/v2.LogsMetricFilter.html | 2 +- classes/v2.LogsMetricGroupBy.html | 4 +- classes/v2.LogsMetricResponse.html | 2 +- classes/v2.LogsMetricResponseAttributes.html | 2 +- classes/v2.LogsMetricResponseCompute.html | 2 +- classes/v2.LogsMetricResponseData.html | 4 +- classes/v2.LogsMetricResponseFilter.html | 2 +- classes/v2.LogsMetricResponseGroupBy.html | 4 +- classes/v2.LogsMetricUpdateAttributes.html | 2 +- classes/v2.LogsMetricUpdateData.html | 2 +- classes/v2.LogsMetricUpdateRequest.html | 2 +- classes/v2.LogsMetricsApi.html | 10 +- classes/v2.LogsMetricsResponse.html | 2 +- classes/v2.LogsQueryFilter.html | 8 +- classes/v2.LogsQueryOptions.html | 4 +- classes/v2.LogsResponseMetadata.html | 6 +- classes/v2.LogsResponseMetadataPage.html | 2 +- classes/v2.LogsWarning.html | 6 +- classes/v2.Metric.html | 4 +- classes/v2.MetricAllTags.html | 4 +- classes/v2.MetricAllTagsAttributes.html | 2 +- classes/v2.MetricAllTagsResponse.html | 2 +- classes/v2.MetricBulkTagConfigCreate.html | 4 +- ...2.MetricBulkTagConfigCreateAttributes.html | 4 +- .../v2.MetricBulkTagConfigCreateRequest.html | 2 +- classes/v2.MetricBulkTagConfigDelete.html | 4 +- ...2.MetricBulkTagConfigDeleteAttributes.html | 2 +- .../v2.MetricBulkTagConfigDeleteRequest.html | 2 +- classes/v2.MetricBulkTagConfigResponse.html | 2 +- classes/v2.MetricBulkTagConfigStatus.html | 4 +- ...2.MetricBulkTagConfigStatusAttributes.html | 6 +- classes/v2.MetricCustomAggregation.html | 2 +- classes/v2.MetricDistinctVolume.html | 4 +- .../v2.MetricDistinctVolumeAttributes.html | 2 +- classes/v2.MetricIngestedIndexedVolume.html | 4 +- ...MetricIngestedIndexedVolumeAttributes.html | 4 +- classes/v2.MetricTagConfiguration.html | 4 +- .../v2.MetricTagConfigurationAttributes.html | 10 +- ...etricTagConfigurationCreateAttributes.html | 6 +- .../v2.MetricTagConfigurationCreateData.html | 4 +- ...2.MetricTagConfigurationCreateRequest.html | 2 +- .../v2.MetricTagConfigurationResponse.html | 2 +- ...etricTagConfigurationUpdateAttributes.html | 6 +- .../v2.MetricTagConfigurationUpdateData.html | 4 +- ...2.MetricTagConfigurationUpdateRequest.html | 2 +- classes/v2.MetricVolumesResponse.html | 2 +- ...icsAndMetricTagConfigurationsResponse.html | 2 +- classes/v2.MetricsApi.html | 18 +- classes/v2.NullableRelationshipToUser.html | 2 +- .../v2.NullableRelationshipToUserData.html | 4 +- classes/v2.Organization.html | 4 +- classes/v2.OrganizationAttributes.html | 16 +- classes/v2.Pagination.html | 4 +- classes/v2.PartialAPIKey.html | 4 +- classes/v2.PartialAPIKeyAttributes.html | 8 +- classes/v2.PartialApplicationKey.html | 4 +- .../v2.PartialApplicationKeyAttributes.html | 8 +- classes/v2.PartialApplicationKeyResponse.html | 2 +- classes/v2.Permission.html | 4 +- classes/v2.PermissionAttributes.html | 14 +- classes/v2.PermissionsResponse.html | 2 +- classes/v2.ProcessSummariesMeta.html | 2 +- classes/v2.ProcessSummariesMetaPage.html | 4 +- classes/v2.ProcessSummariesResponse.html | 4 +- classes/v2.ProcessSummary.html | 4 +- classes/v2.ProcessSummaryAttributes.html | 16 +- classes/v2.ProcessesApi.html | 2 +- ...shipToIncidentIntegrationMetadataData.html | 4 +- ...ionshipToIncidentIntegrationMetadatas.html | 2 +- .../v2.RelationshipToIncidentPostmortem.html | 2 +- ....RelationshipToIncidentPostmortemData.html | 4 +- classes/v2.RelationshipToOrganization.html | 2 +- .../v2.RelationshipToOrganizationData.html | 4 +- classes/v2.RelationshipToOrganizations.html | 2 +- classes/v2.RelationshipToPermission.html | 2 +- classes/v2.RelationshipToPermissionData.html | 4 +- classes/v2.RelationshipToPermissions.html | 2 +- classes/v2.RelationshipToRole.html | 2 +- classes/v2.RelationshipToRoleData.html | 4 +- classes/v2.RelationshipToRoles.html | 2 +- ....RelationshipToSAMLAssertionAttribute.html | 2 +- ...ationshipToSAMLAssertionAttributeData.html | 4 +- classes/v2.RelationshipToUser.html | 2 +- classes/v2.RelationshipToUserData.html | 4 +- classes/v2.RelationshipToUsers.html | 2 +- classes/v2.RequestContext.html | 8 +- classes/v2.ResponseContext.html | 2 +- classes/v2.ResponseMetaAttributes.html | 2 +- classes/v2.Role.html | 4 +- classes/v2.RoleAttributes.html | 8 +- classes/v2.RoleClone.html | 2 +- classes/v2.RoleCloneAttributes.html | 2 +- classes/v2.RoleCloneRequest.html | 2 +- classes/v2.RoleCreateAttributes.html | 6 +- classes/v2.RoleCreateData.html | 2 +- classes/v2.RoleCreateRequest.html | 2 +- classes/v2.RoleCreateResponse.html | 2 +- classes/v2.RoleCreateResponseData.html | 4 +- classes/v2.RoleRelationships.html | 2 +- classes/v2.RoleResponse.html | 2 +- classes/v2.RoleResponseRelationships.html | 2 +- classes/v2.RoleUpdateAttributes.html | 6 +- classes/v2.RoleUpdateData.html | 4 +- classes/v2.RoleUpdateRequest.html | 2 +- classes/v2.RoleUpdateResponse.html | 2 +- classes/v2.RoleUpdateResponseData.html | 4 +- classes/v2.RolesApi.html | 26 +- classes/v2.RolesResponse.html | 4 +- classes/v2.SAMLAssertionAttribute.html | 4 +- .../v2.SAMLAssertionAttributeAttributes.html | 4 +- classes/v2.SecurityFilter.html | 4 +- classes/v2.SecurityFilterAttributes.html | 12 +- .../v2.SecurityFilterCreateAttributes.html | 8 +- classes/v2.SecurityFilterCreateData.html | 2 +- classes/v2.SecurityFilterCreateRequest.html | 2 +- classes/v2.SecurityFilterExclusionFilter.html | 4 +- ...SecurityFilterExclusionFilterResponse.html | 4 +- classes/v2.SecurityFilterMeta.html | 2 +- classes/v2.SecurityFilterResponse.html | 2 +- .../v2.SecurityFilterUpdateAttributes.html | 10 +- classes/v2.SecurityFilterUpdateData.html | 2 +- classes/v2.SecurityFilterUpdateRequest.html | 2 +- classes/v2.SecurityFiltersResponse.html | 4 +- classes/v2.SecurityMonitoringApi.html | 24 +- classes/v2.SecurityMonitoringFilter.html | 2 +- ...2.SecurityMonitoringListRulesResponse.html | 4 +- classes/v2.SecurityMonitoringRuleCase.html | 8 +- .../v2.SecurityMonitoringRuleCaseCreate.html | 8 +- ...2.SecurityMonitoringRuleCreatePayload.html | 18 +- ...SecurityMonitoringRuleNewValueOptions.html | 2 +- classes/v2.SecurityMonitoringRuleOptions.html | 2 +- classes/v2.SecurityMonitoringRuleQuery.html | 10 +- .../v2.SecurityMonitoringRuleQueryCreate.html | 10 +- .../v2.SecurityMonitoringRuleResponse.html | 30 +- ...2.SecurityMonitoringRuleUpdatePayload.html | 18 +- classes/v2.SecurityMonitoringSignal.html | 4 +- ...v2.SecurityMonitoringSignalAttributes.html | 8 +- ...2.SecurityMonitoringSignalListRequest.html | 2 +- ...rityMonitoringSignalListRequestFilter.html | 6 +- ...curityMonitoringSignalListRequestPage.html | 4 +- ...SecurityMonitoringSignalsListResponse.html | 4 +- ...ityMonitoringSignalsListResponseLinks.html | 2 +- ...rityMonitoringSignalsListResponseMeta.html | 2 +- ...MonitoringSignalsListResponseMetaPage.html | 2 +- classes/v2.SelfDecodingBody.html | 2 +- classes/v2.ServerConfiguration.html | 4 +- .../v2.ServiceAccountCreateAttributes.html | 8 +- classes/v2.ServiceAccountCreateData.html | 2 +- classes/v2.ServiceAccountCreateRequest.html | 2 +- classes/v2.ServiceAccountsApi.html | 10 +- classes/v2.User.html | 4 +- classes/v2.UserAttributes.html | 22 +- classes/v2.UserCreateAttributes.html | 6 +- classes/v2.UserCreateData.html | 2 +- classes/v2.UserCreateRequest.html | 2 +- classes/v2.UserInvitationData.html | 2 +- classes/v2.UserInvitationDataAttributes.html | 8 +- classes/v2.UserInvitationRelationships.html | 2 +- classes/v2.UserInvitationResponse.html | 2 +- classes/v2.UserInvitationResponseData.html | 4 +- classes/v2.UserInvitationsRequest.html | 2 +- classes/v2.UserInvitationsResponse.html | 2 +- classes/v2.UserRelationships.html | 2 +- classes/v2.UserResponse.html | 2 +- classes/v2.UserResponseRelationships.html | 2 +- classes/v2.UserUpdateAttributes.html | 6 +- classes/v2.UserUpdateData.html | 4 +- classes/v2.UserUpdateRequest.html | 2 +- classes/v2.UsersApi.html | 20 +- classes/v2.UsersResponse.html | 6 +- enums/v1.HttpMethod.html | 2 +- enums/v2.HttpMethod.html | 2 +- ...IntegrationApiCreateAWSAccountRequest.html | 2 +- ...tegrationApiCreateAWSTagFilterRequest.html | 2 +- ...ationApiCreateNewAWSExternalIDRequest.html | 2 +- ...IntegrationApiDeleteAWSAccountRequest.html | 2 +- ...tegrationApiDeleteAWSTagFilterRequest.html | 2 +- ...SIntegrationApiListAWSAccountsRequest.html | 6 +- ...ntegrationApiListAWSTagFiltersRequest.html | 2 +- ...IntegrationApiUpdateAWSAccountRequest.html | 8 +- ...tionApiCheckAWSLogsLambdaAsyncRequest.html | 2 +- ...onApiCheckAWSLogsServicesAsyncRequest.html | 2 +- ...tegrationApiCreateAWSLambdaARNRequest.html | 2 +- ...tegrationApiDeleteAWSLambdaARNRequest.html | 2 +- ...grationApiEnableAWSLogServicesRequest.html | 2 +- interfaces/v1.AbortSignal.html | 2 +- ...ationApiCreateAzureIntegrationRequest.html | 2 +- ...ationApiDeleteAzureIntegrationRequest.html | 2 +- ...ationApiUpdateAzureHostFiltersRequest.html | 2 +- ...ationApiUpdateAzureIntegrationRequest.html | 2 +- interfaces/v1.Configuration.html | 2 +- ...ardListsApiCreateDashboardListRequest.html | 2 +- ...ardListsApiDeleteDashboardListRequest.html | 2 +- ...hboardListsApiGetDashboardListRequest.html | 2 +- ...ardListsApiUpdateDashboardListRequest.html | 4 +- ...1.DashboardsApiCreateDashboardRequest.html | 2 +- ...1.DashboardsApiDeleteDashboardRequest.html | 2 +- ....DashboardsApiDeleteDashboardsRequest.html | 2 +- .../v1.DashboardsApiGetDashboardRequest.html | 2 +- ...v1.DashboardsApiListDashboardsRequest.html | 4 +- ...DashboardsApiRestoreDashboardsRequest.html | 2 +- ...1.DashboardsApiUpdateDashboardRequest.html | 4 +- .../v1.DowntimesApiCancelDowntimeRequest.html | 2 +- ...timesApiCancelDowntimesByScopeRequest.html | 2 +- .../v1.DowntimesApiCreateDowntimeRequest.html | 2 +- .../v1.DowntimesApiGetDowntimeRequest.html | 2 +- .../v1.DowntimesApiListDowntimesRequest.html | 2 +- ...wntimesApiListMonitorDowntimesRequest.html | 2 +- .../v1.DowntimesApiUpdateDowntimeRequest.html | 4 +- .../v1.EventsApiCreateEventRequest.html | 2 +- interfaces/v1.EventsApiGetEventRequest.html | 2 +- interfaces/v1.EventsApiListEventsRequest.html | 16 +- ...grationApiCreateGCPIntegrationRequest.html | 2 +- ...grationApiDeleteGCPIntegrationRequest.html | 2 +- ...grationApiUpdateGCPIntegrationRequest.html | 2 +- .../v1.HostsApiGetHostTotalsRequest.html | 2 +- interfaces/v1.HostsApiListHostsRequest.html | 16 +- interfaces/v1.HostsApiMuteHostRequest.html | 4 +- interfaces/v1.HostsApiUnmuteHostRequest.html | 2 +- interfaces/v1.HttpConfiguration.html | 2 +- interfaces/v1.HttpLibrary.html | 2 +- ...1.KeyManagementApiCreateAPIKeyRequest.html | 2 +- ...agementApiCreateApplicationKeyRequest.html | 2 +- ...1.KeyManagementApiDeleteAPIKeyRequest.html | 2 +- ...agementApiDeleteApplicationKeyRequest.html | 2 +- .../v1.KeyManagementApiGetAPIKeyRequest.html | 2 +- ...ManagementApiGetApplicationKeyRequest.html | 2 +- ...1.KeyManagementApiUpdateAPIKeyRequest.html | 2 +- ...agementApiUpdateApplicationKeyRequest.html | 2 +- interfaces/v1.LogsApiListLogsRequest.html | 2 +- interfaces/v1.LogsApiSubmitLogRequest.html | 6 +- ....LogsIndexesApiCreateLogsIndexRequest.html | 2 +- .../v1.LogsIndexesApiGetLogsIndexRequest.html | 2 +- ...IndexesApiUpdateLogsIndexOrderRequest.html | 2 +- ....LogsIndexesApiUpdateLogsIndexRequest.html | 4 +- ...PipelinesApiCreateLogsPipelineRequest.html | 2 +- ...PipelinesApiDeleteLogsPipelineRequest.html | 2 +- ...ogsPipelinesApiGetLogsPipelineRequest.html | 2 +- ...inesApiUpdateLogsPipelineOrderRequest.html | 2 +- ...PipelinesApiUpdateLogsPipelineRequest.html | 4 +- ...v1.MetricsApiGetMetricMetadataRequest.html | 2 +- ...v1.MetricsApiListActiveMetricsRequest.html | 6 +- .../v1.MetricsApiListMetricsRequest.html | 2 +- .../v1.MetricsApiQueryMetricsRequest.html | 6 +- .../v1.MetricsApiSubmitMetricsRequest.html | 2 +- ...MetricsApiUpdateMetricMetadataRequest.html | 4 +- ...nitorsApiCheckCanDeleteMonitorRequest.html | 2 +- .../v1.MonitorsApiCreateMonitorRequest.html | 2 +- .../v1.MonitorsApiDeleteMonitorRequest.html | 4 +- .../v1.MonitorsApiGetMonitorRequest.html | 4 +- .../v1.MonitorsApiListMonitorsRequest.html | 16 +- ...MonitorsApiSearchMonitorGroupsRequest.html | 8 +- .../v1.MonitorsApiSearchMonitorsRequest.html | 8 +- .../v1.MonitorsApiUpdateMonitorRequest.html | 4 +- .../v1.MonitorsApiValidateMonitorRequest.html | 2 +- .../v1.NotebooksApiCreateNotebookRequest.html | 2 +- .../v1.NotebooksApiDeleteNotebookRequest.html | 2 +- .../v1.NotebooksApiGetNotebookRequest.html | 2 +- .../v1.NotebooksApiListNotebooksRequest.html | 20 +- .../v1.NotebooksApiUpdateNotebookRequest.html | 4 +- ...OrganizationsApiCreateChildOrgRequest.html | 2 +- .../v1.OrganizationsApiGetOrgRequest.html | 2 +- .../v1.OrganizationsApiUpdateOrgRequest.html | 2 +- ...rganizationsApiUploadIdPForOrgRequest.html | 4 +- ...atePagerDutyIntegrationServiceRequest.html | 2 +- ...etePagerDutyIntegrationServiceRequest.html | 2 +- ...GetPagerDutyIntegrationServiceRequest.html | 2 +- ...atePagerDutyIntegrationServiceRequest.html | 4 +- interfaces/v1.ResponseBody.html | 2 +- interfaces/v1.SecurityAuthentication.html | 4 +- ...iceChecksApiSubmitServiceCheckRequest.html | 2 +- ...rectionsApiCreateSLOCorrectionRequest.html | 2 +- ...rectionsApiDeleteSLOCorrectionRequest.html | 2 +- ...CorrectionsApiGetSLOCorrectionRequest.html | 2 +- ...rectionsApiUpdateSLOCorrectionRequest.html | 4 +- ...ObjectivesApiCheckCanDeleteSLORequest.html | 2 +- ...iceLevelObjectivesApiCreateSLORequest.html | 2 +- ...iceLevelObjectivesApiDeleteSLORequest.html | 4 +- ...vesApiDeleteSLOTimeframeInBulkRequest.html | 2 +- ...ObjectivesApiGetSLOCorrectionsRequest.html | 2 +- ...evelObjectivesApiGetSLOHistoryRequest.html | 10 +- ...erviceLevelObjectivesApiGetSLORequest.html | 4 +- ...viceLevelObjectivesApiListSLOsRequest.html | 12 +- ...iceLevelObjectivesApiUpdateSLORequest.html | 4 +- ...iCreateSlackIntegrationChannelRequest.html | 4 +- ...nApiGetSlackIntegrationChannelRequest.html | 4 +- ...ApiGetSlackIntegrationChannelsRequest.html | 2 +- ...iRemoveSlackIntegrationChannelRequest.html | 4 +- ...iUpdateSlackIntegrationChannelRequest.html | 6 +- ...1.SnapshotsApiGetGraphSnapshotRequest.html | 12 +- ...theticsApiCreateGlobalVariableRequest.html | 2 +- ...heticsApiCreatePrivateLocationRequest.html | 2 +- ...ticsApiCreateSyntheticsAPITestRequest.html | 2 +- ...ApiCreateSyntheticsBrowserTestRequest.html | 2 +- ...theticsApiDeleteGlobalVariableRequest.html | 2 +- ...heticsApiDeletePrivateLocationRequest.html | 2 +- .../v1.SyntheticsApiDeleteTestsRequest.html | 2 +- ...yntheticsApiEditGlobalVariableRequest.html | 4 +- ...ticsApiGetAPITestLatestResultsRequest.html | 8 +- .../v1.SyntheticsApiGetAPITestRequest.html | 2 +- ....SyntheticsApiGetAPITestResultRequest.html | 4 +- ...ApiGetBrowserTestLatestResultsRequest.html | 8 +- ...v1.SyntheticsApiGetBrowserTestRequest.html | 2 +- ...theticsApiGetBrowserTestResultRequest.html | 4 +- ...SyntheticsApiGetGlobalVariableRequest.html | 2 +- ...yntheticsApiGetPrivateLocationRequest.html | 2 +- ...theticsApiGetSyntheticsCIBatchRequest.html | 2 +- .../v1.SyntheticsApiGetTestRequest.html | 2 +- ...v1.SyntheticsApiTriggerCITestsRequest.html | 2 +- .../v1.SyntheticsApiTriggerTestsRequest.html | 2 +- .../v1.SyntheticsApiUpdateAPITestRequest.html | 4 +- ...SyntheticsApiUpdateBrowserTestRequest.html | 4 +- ...heticsApiUpdatePrivateLocationRequest.html | 4 +- ...heticsApiUpdateTestPauseStatusRequest.html | 4 +- .../v1.TagsApiCreateHostTagsRequest.html | 6 +- .../v1.TagsApiDeleteHostTagsRequest.html | 4 +- interfaces/v1.TagsApiGetHostTagsRequest.html | 4 +- interfaces/v1.TagsApiListHostTagsRequest.html | 2 +- .../v1.TagsApiUpdateHostTagsRequest.html | 6 +- interfaces/v1.TokenProvider.html | 2 +- ...teringApiGetDailyCustomReportsRequest.html | 8 +- ...ngApiGetHourlyUsageAttributionRequest.html | 10 +- ...teringApiGetIncidentManagementRequest.html | 4 +- ...ageMeteringApiGetIngestedSpansRequest.html | 4 +- ...ringApiGetMonthlyCustomReportsRequest.html | 8 +- ...gApiGetMonthlyUsageAttributionRequest.html | 14 +- ...GetSpecifiedDailyCustomReportsRequest.html | 2 +- ...tSpecifiedMonthlyCustomReportsRequest.html | 2 +- ...eteringApiGetUsageAnalyzedLogsRequest.html | 4 +- ...MeteringApiGetUsageAttributionRequest.html | 16 +- ...geMeteringApiGetUsageAuditLogsRequest.html | 4 +- ...ringApiGetUsageBillableSummaryRequest.html | 2 +- ...v1.UsageMeteringApiGetUsageCWSRequest.html | 4 +- ...CloudSecurityPostureManagementRequest.html | 4 +- ...v1.UsageMeteringApiGetUsageDBMRequest.html | 4 +- ...sageMeteringApiGetUsageFargateRequest.html | 4 +- ....UsageMeteringApiGetUsageHostsRequest.html | 4 +- ...eteringApiGetUsageIndexedSpansRequest.html | 4 +- ...ingApiGetUsageInternetOfThingsRequest.html | 4 +- ...UsageMeteringApiGetUsageLambdaRequest.html | 4 +- ...MeteringApiGetUsageLogsByIndexRequest.html | 6 +- ...ringApiGetUsageLogsByRetentionRequest.html | 4 +- ...1.UsageMeteringApiGetUsageLogsRequest.html | 4 +- ...eteringApiGetUsageNetworkFlowsRequest.html | 4 +- ...eteringApiGetUsageNetworkHostsRequest.html | 4 +- ...geMeteringApiGetUsageProfilingRequest.html | 4 +- ...MeteringApiGetUsageRumSessionsRequest.html | 6 +- ...ageMeteringApiGetUsageRumUnitsRequest.html | 4 +- ...v1.UsageMeteringApiGetUsageSDSRequest.html | 4 +- ...1.UsageMeteringApiGetUsageSNMPRequest.html | 4 +- ...sageMeteringApiGetUsageSummaryRequest.html | 6 +- ...teringApiGetUsageSyntheticsAPIRequest.html | 4 +- ...ngApiGetUsageSyntheticsBrowserRequest.html | 4 +- ...eMeteringApiGetUsageSyntheticsRequest.html | 4 +- ...eMeteringApiGetUsageTimeseriesRequest.html | 4 +- ...teringApiGetUsageTopAvgMetricsRequest.html | 10 +- interfaces/v1.UsersApiCreateUserRequest.html | 2 +- interfaces/v1.UsersApiDisableUserRequest.html | 2 +- interfaces/v1.UsersApiGetUserRequest.html | 2 +- interfaces/v1.UsersApiUpdateUserRequest.html | 4 +- ...hooksIntegrationCustomVariableRequest.html | 2 +- ...onApiCreateWebhooksIntegrationRequest.html | 2 +- ...hooksIntegrationCustomVariableRequest.html | 2 +- ...onApiDeleteWebhooksIntegrationRequest.html | 2 +- ...hooksIntegrationCustomVariableRequest.html | 2 +- ...ationApiGetWebhooksIntegrationRequest.html | 2 +- ...hooksIntegrationCustomVariableRequest.html | 4 +- ...onApiUpdateWebhooksIntegrationRequest.html | 4 +- interfaces/v2.AbortSignal.html | 2 +- ...NMappingsApiCreateAuthNMappingRequest.html | 2 +- ...NMappingsApiDeleteAuthNMappingRequest.html | 2 +- ...uthNMappingsApiGetAuthNMappingRequest.html | 2 +- ...hNMappingsApiListAuthNMappingsRequest.html | 10 +- ...NMappingsApiUpdateAuthNMappingRequest.html | 4 +- ...CloudWorkloadSecurityAgentRuleRequest.html | 2 +- ...CloudWorkloadSecurityAgentRuleRequest.html | 2 +- ...CloudWorkloadSecurityAgentRuleRequest.html | 2 +- ...CloudWorkloadSecurityAgentRuleRequest.html | 4 +- interfaces/v2.Configuration.html | 2 +- ...stsApiCreateDashboardListItemsRequest.html | 4 +- ...stsApiDeleteDashboardListItemsRequest.html | 4 +- ...dListsApiGetDashboardListItemsRequest.html | 2 +- ...stsApiUpdateDashboardListItemsRequest.html | 4 +- interfaces/v2.HttpConfiguration.html | 2 +- interfaces/v2.HttpLibrary.html | 2 +- ...rvicesApiCreateIncidentServiceRequest.html | 2 +- ...rvicesApiDeleteIncidentServiceRequest.html | 2 +- ...tServicesApiGetIncidentServiceRequest.html | 4 +- ...ervicesApiListIncidentServicesRequest.html | 8 +- ...rvicesApiUpdateIncidentServiceRequest.html | 4 +- ...dentTeamsApiCreateIncidentTeamRequest.html | 2 +- ...dentTeamsApiDeleteIncidentTeamRequest.html | 2 +- ...ncidentTeamsApiGetIncidentTeamRequest.html | 4 +- ...identTeamsApiListIncidentTeamsRequest.html | 8 +- ...dentTeamsApiUpdateIncidentTeamRequest.html | 4 +- .../v2.IncidentsApiCreateIncidentRequest.html | 2 +- .../v2.IncidentsApiDeleteIncidentRequest.html | 2 +- .../v2.IncidentsApiGetIncidentRequest.html | 4 +- .../v2.IncidentsApiListIncidentsRequest.html | 6 +- .../v2.IncidentsApiUpdateIncidentRequest.html | 6 +- ...2.KeyManagementApiCreateAPIKeyRequest.html | 2 +- ...reateCurrentUserApplicationKeyRequest.html | 2 +- ...2.KeyManagementApiDeleteAPIKeyRequest.html | 2 +- ...agementApiDeleteApplicationKeyRequest.html | 2 +- ...eleteCurrentUserApplicationKeyRequest.html | 2 +- .../v2.KeyManagementApiGetAPIKeyRequest.html | 4 +- ...ManagementApiGetApplicationKeyRequest.html | 4 +- ...piGetCurrentUserApplicationKeyRequest.html | 2 +- ...v2.KeyManagementApiListAPIKeysRequest.html | 18 +- ...nagementApiListApplicationKeysRequest.html | 12 +- ...ListCurrentUserApplicationKeysRequest.html | 12 +- ...2.KeyManagementApiUpdateAPIKeyRequest.html | 4 +- ...agementApiUpdateApplicationKeyRequest.html | 4 +- ...pdateCurrentUserApplicationKeyRequest.html | 4 +- .../v2.LogsApiAggregateLogsRequest.html | 2 +- interfaces/v2.LogsApiListLogsGetRequest.html | 14 +- interfaces/v2.LogsApiListLogsRequest.html | 2 +- interfaces/v2.LogsApiSubmitLogRequest.html | 6 +- ...rchivesApiAddReadRoleToArchiveRequest.html | 4 +- ...gsArchivesApiCreateLogsArchiveRequest.html | 2 +- ...gsArchivesApiDeleteLogsArchiveRequest.html | 2 +- ....LogsArchivesApiGetLogsArchiveRequest.html | 2 +- ...rchivesApiListArchiveReadRolesRequest.html | 2 +- ...chivesApiRemoveRoleFromArchiveRequest.html | 4 +- ...hivesApiUpdateLogsArchiveOrderRequest.html | 2 +- ...gsArchivesApiUpdateLogsArchiveRequest.html | 4 +- ...LogsMetricsApiCreateLogsMetricRequest.html | 2 +- ...LogsMetricsApiDeleteLogsMetricRequest.html | 2 +- ...v2.LogsMetricsApiGetLogsMetricRequest.html | 2 +- ...LogsMetricsApiUpdateLogsMetricRequest.html | 4 +- ...teBulkTagsMetricsConfigurationRequest.html | 2 +- ...tricsApiCreateTagConfigurationRequest.html | 2 +- ...teBulkTagsMetricsConfigurationRequest.html | 2 +- ...tricsApiDeleteTagConfigurationRequest.html | 2 +- ...sApiListTagConfigurationByNameRequest.html | 2 +- ...etricsApiListTagConfigurationsRequest.html | 12 +- ...MetricsApiListTagsByMetricNameRequest.html | 2 +- ...ricsApiListVolumesByMetricNameRequest.html | 2 +- ...tricsApiUpdateTagConfigurationRequest.html | 2 +- .../v2.ProcessesApiListProcessesRequest.html | 12 +- interfaces/v2.ResponseBody.html | 2 +- ...v2.RolesApiAddPermissionToRoleRequest.html | 2 +- .../v2.RolesApiAddUserToRoleRequest.html | 2 +- interfaces/v2.RolesApiCloneRoleRequest.html | 2 +- interfaces/v2.RolesApiCreateRoleRequest.html | 2 +- interfaces/v2.RolesApiDeleteRoleRequest.html | 2 +- interfaces/v2.RolesApiGetRoleRequest.html | 2 +- ...v2.RolesApiListRolePermissionsRequest.html | 2 +- .../v2.RolesApiListRoleUsersRequest.html | 10 +- interfaces/v2.RolesApiListRolesRequest.html | 8 +- ...lesApiRemovePermissionFromRoleRequest.html | 2 +- .../v2.RolesApiRemoveUserFromRoleRequest.html | 2 +- interfaces/v2.RolesApiUpdateRoleRequest.html | 2 +- interfaces/v2.SecurityAuthentication.html | 4 +- ...itoringApiCreateSecurityFilterRequest.html | 2 +- ...piCreateSecurityMonitoringRuleRequest.html | 2 +- ...itoringApiDeleteSecurityFilterRequest.html | 2 +- ...piDeleteSecurityMonitoringRuleRequest.html | 2 +- ...MonitoringApiGetSecurityFilterRequest.html | 2 +- ...ngApiGetSecurityMonitoringRuleRequest.html | 2 +- ...ApiListSecurityMonitoringRulesRequest.html | 4 +- ...iListSecurityMonitoringSignalsRequest.html | 12 +- ...earchSecurityMonitoringSignalsRequest.html | 2 +- ...itoringApiUpdateSecurityFilterRequest.html | 4 +- ...piUpdateSecurityMonitoringRuleRequest.html | 2 +- ...teServiceAccountApplicationKeyRequest.html | 2 +- ...teServiceAccountApplicationKeyRequest.html | 4 +- ...etServiceAccountApplicationKeyRequest.html | 4 +- ...tServiceAccountApplicationKeysRequest.html | 14 +- ...teServiceAccountApplicationKeyRequest.html | 4 +- interfaces/v2.TokenProvider.html | 2 +- ...2.UsersApiCreateServiceAccountRequest.html | 2 +- interfaces/v2.UsersApiCreateUserRequest.html | 2 +- interfaces/v2.UsersApiDisableUserRequest.html | 2 +- .../v2.UsersApiGetInvitationRequest.html | 2 +- interfaces/v2.UsersApiGetUserRequest.html | 2 +- ....UsersApiListUserOrganizationsRequest.html | 2 +- ...v2.UsersApiListUserPermissionsRequest.html | 2 +- interfaces/v2.UsersApiListUsersRequest.html | 12 +- .../v2.UsersApiSendInvitationsRequest.html | 2 +- interfaces/v2.UsersApiUpdateUserRequest.html | 2 +- modules.html | 2 +- modules/v1.html | 378 +++++++++--------- modules/v2.html | 172 ++++---- 1180 files changed, 3851 insertions(+), 3851 deletions(-) diff --git a/classes/v1.APIErrorResponse.html b/classes/v1.APIErrorResponse.html index e51eb86c624..54e9a48c6fd 100644 --- a/classes/v1.APIErrorResponse.html +++ b/classes/v1.APIErrorResponse.html @@ -1,5 +1,5 @@ APIErrorResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIErrorResponse

Error response object.

-

Hierarchy

  • APIErrorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

errors

errors: string[]
+

Hierarchy

  • APIErrorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

errors

errors: string[]

Array of errors returned by the API.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSAccount.html b/classes/v1.AWSAccount.html index 4add0ae389f..5e35f256d81 100644 --- a/classes/v1.AWSAccount.html +++ b/classes/v1.AWSAccount.html @@ -1,25 +1,25 @@ AWSAccount | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSAccount

Returns the AWS account associated with this integration.

-

Hierarchy

  • AWSAccount

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accessKeyId

accessKeyId?: string
+

Hierarchy

  • AWSAccount

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accessKeyId

accessKeyId?: string

Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.

-

Optional accountId

accountId?: string
+

Optional accountId

accountId?: string

Your AWS Account ID without dashes.

-

Optional accountSpecificNamespaceRules

accountSpecificNamespaceRules?: {}
+

Optional accountSpecificNamespaceRules

accountSpecificNamespaceRules?: {}

An object, (in the form {\"namespace1\":true/false, \"namespace2\":true/false}), that enables or disables metric collection for specific AWS namespaces for this AWS account only.

-

Type declaration

  • [key: string]: boolean

Optional cspmResourceCollectionEnabled

cspmResourceCollectionEnabled?: boolean
+

Type declaration

  • [key: string]: boolean

Optional cspmResourceCollectionEnabled

cspmResourceCollectionEnabled?: boolean

Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general resource_collection.

-

Optional excludedRegions

excludedRegions?: string[]
+

Optional excludedRegions

excludedRegions?: string[]

An array of AWS regions to exclude from metrics collection.

-

Optional filterTags

filterTags?: string[]
+

Optional filterTags

filterTags?: string[]

The array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding ! before the tag. For example, env:production,instance-type:c1.*,!region:us-east-1

-

Optional hostTags

hostTags?: string[]
+

Optional hostTags

hostTags?: string[]

Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.

-

Optional metricsCollectionEnabled

metricsCollectionEnabled?: boolean
+

Optional metricsCollectionEnabled

metricsCollectionEnabled?: boolean

Whether Datadog collects metrics for this AWS account.

-

Optional resourceCollectionEnabled

resourceCollectionEnabled?: boolean
+

Optional resourceCollectionEnabled

resourceCollectionEnabled?: boolean

Whether Datadog collects a standard set of resources from your AWS account.

-

Optional roleName

roleName?: string
+

Optional roleName

roleName?: string

Your Datadog role delegation name.

-

Optional secretAccessKey

secretAccessKey?: string
+

Optional secretAccessKey

secretAccessKey?: string

Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSAccountAndLambdaRequest.html b/classes/v1.AWSAccountAndLambdaRequest.html index 0448158198b..03c90dbd40a 100644 --- a/classes/v1.AWSAccountAndLambdaRequest.html +++ b/classes/v1.AWSAccountAndLambdaRequest.html @@ -1,7 +1,7 @@ AWSAccountAndLambdaRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSAccountAndLambdaRequest

AWS account ID and Lambda ARN.

-

Hierarchy

  • AWSAccountAndLambdaRequest

Index

Constructors

Properties

Constructors

constructor

Properties

accountId

accountId: string
+

Hierarchy

  • AWSAccountAndLambdaRequest

Index

Constructors

Properties

Constructors

constructor

Properties

accountId

accountId: string

Your AWS Account ID without dashes.

-

lambdaArn

lambdaArn: string
+

lambdaArn

lambdaArn: string

ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSAccountCreateResponse.html b/classes/v1.AWSAccountCreateResponse.html index f67531961c9..8da385ea41f 100644 --- a/classes/v1.AWSAccountCreateResponse.html +++ b/classes/v1.AWSAccountCreateResponse.html @@ -1,5 +1,5 @@ AWSAccountCreateResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSAccountCreateResponse

The Response returned by the AWS Create Account call.

-

Hierarchy

  • AWSAccountCreateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional externalId

externalId?: string
+

Hierarchy

  • AWSAccountCreateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional externalId

externalId?: string

AWS external_id.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSAccountDeleteRequest.html b/classes/v1.AWSAccountDeleteRequest.html index 075fd3272ca..c54494e06b5 100644 --- a/classes/v1.AWSAccountDeleteRequest.html +++ b/classes/v1.AWSAccountDeleteRequest.html @@ -1,9 +1,9 @@ AWSAccountDeleteRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSAccountDeleteRequest

List of AWS accounts to delete.

-

Hierarchy

  • AWSAccountDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accessKeyId

accessKeyId?: string
+

Hierarchy

  • AWSAccountDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accessKeyId

accessKeyId?: string

Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.

-

Optional accountId

accountId?: string
+

Optional accountId

accountId?: string

Your AWS Account ID without dashes.

-

Optional roleName

roleName?: string
+

Optional roleName

roleName?: string

Your Datadog role delegation name.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSAccountListResponse.html b/classes/v1.AWSAccountListResponse.html index ad775b240ff..eea10551a9f 100644 --- a/classes/v1.AWSAccountListResponse.html +++ b/classes/v1.AWSAccountListResponse.html @@ -1,5 +1,5 @@ AWSAccountListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSAccountListResponse

List of enabled AWS accounts.

-

Hierarchy

  • AWSAccountListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accounts

accounts?: AWSAccount[]
+

Hierarchy

  • AWSAccountListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accounts

accounts?: AWSAccount[]

List of enabled AWS accounts.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSIntegrationApi.html b/classes/v1.AWSIntegrationApi.html index 70533866b87..f690fb8aadf 100644 --- a/classes/v1.AWSIntegrationApi.html +++ b/classes/v1.AWSIntegrationApi.html @@ -1,34 +1,34 @@ -AWSIntegrationApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSIntegrationApi

Hierarchy

  • AWSIntegrationApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AWSIntegrationApi(configuration: v1.Configuration, requestFactory?: AWSIntegrationApiRequestFactory, responseProcessor?: AWSIntegrationApiResponseProcessor): AWSIntegrationApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: AWSIntegrationApiRequestFactory

Private responseProcessor

responseProcessor: AWSIntegrationApiResponseProcessor

Methods

createAWSAccount

createAWSTagFilter

createNewAWSExternalID

Returns Promise<any>

createNewAWSExternalID

deleteAWSAccount

Returns Promise<AWSAccountCreateResponse>

deleteAWSAccount

deleteAWSTagFilter

Returns Promise<any>

deleteAWSTagFilter

listAWSAccounts

Returns Promise<any>

listAWSAccounts

listAWSTagFilters

Returns Promise<AWSAccountListResponse>

listAWSTagFilters

listAvailableAWSNamespaces

Returns Promise<AWSTagFilterListResponse>

listAvailableAWSNamespaces

updateAWSAccount

updateAWSAccount

createAWSLambdaARN

deleteAWSLambdaARN

Returns Promise<any>

deleteAWSLambdaARN

enableAWSLogServices

Returns Promise<any>

enableAWSLogServices

listAWSLogsIntegrations

Returns Promise<any>

listAWSLogsIntegrations

listAWSLogsServices

listAWSLogsServices

Legend

  • Constructor
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsLambda.html b/classes/v1.AWSLogsLambda.html index 49a49cbbbc7..e2ad60125b1 100644 --- a/classes/v1.AWSLogsLambda.html +++ b/classes/v1.AWSLogsLambda.html @@ -1,5 +1,5 @@ AWSLogsLambda | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSLogsLambda

Description of the Lambdas.

-

Hierarchy

  • AWSLogsLambda

Index

Constructors

Properties

Constructors

constructor

Properties

Optional arn

arn?: string
+

Hierarchy

  • AWSLogsLambda

Index

Constructors

Properties

Constructors

constructor

Properties

Optional arn

arn?: string

Available ARN IDs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsListResponse.html b/classes/v1.AWSLogsListResponse.html index 3309d6f733f..11b6f581409 100644 --- a/classes/v1.AWSLogsListResponse.html +++ b/classes/v1.AWSLogsListResponse.html @@ -1,9 +1,9 @@ AWSLogsListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSLogsListResponse

A list of all Datadog-AWS logs integrations available in your Datadog organization.

-

Hierarchy

  • AWSLogsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountId

accountId?: string
+

Hierarchy

  • AWSLogsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountId

accountId?: string

Your AWS Account ID without dashes.

-

Optional lambdas

lambdas?: AWSLogsLambda[]
+

Optional lambdas

lambdas?: AWSLogsLambda[]

List of ARNs configured in your Datadog account.

-

Optional services

services?: string[]
+

Optional services

services?: string[]

Array of services IDs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsListServicesResponse.html b/classes/v1.AWSLogsListServicesResponse.html index 8996b364d42..8fbe49952af 100644 --- a/classes/v1.AWSLogsListServicesResponse.html +++ b/classes/v1.AWSLogsListServicesResponse.html @@ -1,7 +1,7 @@ AWSLogsListServicesResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSLogsListServicesResponse

The list of current AWS services for which Datadog offers automatic log collection.

-

Hierarchy

  • AWSLogsListServicesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string
+

Hierarchy

  • AWSLogsListServicesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string

Key value in returned object.

-

Optional label

label?: string
+

Optional label

label?: string

Name of service available for configuration with Datadog logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsServicesRequest.html b/classes/v1.AWSLogsServicesRequest.html index 688870fe874..f2588abb2dc 100644 --- a/classes/v1.AWSLogsServicesRequest.html +++ b/classes/v1.AWSLogsServicesRequest.html @@ -1,7 +1,7 @@ AWSLogsServicesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSLogsServicesRequest

A list of current AWS services for which Datadog offers automatic log collection.

-

Hierarchy

  • AWSLogsServicesRequest

Index

Constructors

Properties

Constructors

constructor

Properties

accountId

accountId: string
+

Hierarchy

  • AWSLogsServicesRequest

Index

Constructors

Properties

Constructors

constructor

Properties

accountId

accountId: string

Your AWS Account ID without dashes.

-

services

services: string[]
+

services

services: string[]

Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilter.html b/classes/v1.AWSTagFilter.html index a6cf868b076..b75bf6335ac 100644 --- a/classes/v1.AWSTagFilter.html +++ b/classes/v1.AWSTagFilter.html @@ -1,5 +1,5 @@ AWSTagFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSTagFilter

A tag filter.

-

Hierarchy

  • AWSTagFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional namespace

namespace?: AWSNamespace

Optional tagFilterStr

tagFilterStr?: string
+

Hierarchy

  • AWSTagFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional namespace

namespace?: AWSNamespace

Optional tagFilterStr

tagFilterStr?: string

The tag filter string.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilterCreateRequest.html b/classes/v1.AWSTagFilterCreateRequest.html index 8451e8b7e66..31d311d8d20 100644 --- a/classes/v1.AWSTagFilterCreateRequest.html +++ b/classes/v1.AWSTagFilterCreateRequest.html @@ -1,7 +1,7 @@ AWSTagFilterCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSTagFilterCreateRequest

The objects used to set an AWS tag filter.

-

Hierarchy

  • AWSTagFilterCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountId

accountId?: string
+

Hierarchy

  • AWSTagFilterCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountId

accountId?: string

Your AWS Account ID without dashes.

-

Optional namespace

namespace?: AWSNamespace

Optional tagFilterStr

tagFilterStr?: string
+

Optional namespace

namespace?: AWSNamespace

Optional tagFilterStr

tagFilterStr?: string

The tag filter string.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilterDeleteRequest.html b/classes/v1.AWSTagFilterDeleteRequest.html index f5691198992..7f2a17ec1c1 100644 --- a/classes/v1.AWSTagFilterDeleteRequest.html +++ b/classes/v1.AWSTagFilterDeleteRequest.html @@ -1,5 +1,5 @@ AWSTagFilterDeleteRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSTagFilterDeleteRequest

The objects used to delete an AWS tag filter entry.

-

Hierarchy

  • AWSTagFilterDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountId

accountId?: string
+

Hierarchy

  • AWSTagFilterDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountId

accountId?: string

The unique identifier of your AWS account.

-

Optional namespace

namespace?: AWSNamespace

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional namespace

namespace?: AWSNamespace

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilterListResponse.html b/classes/v1.AWSTagFilterListResponse.html index f1cf0104e5f..0236071bf8f 100644 --- a/classes/v1.AWSTagFilterListResponse.html +++ b/classes/v1.AWSTagFilterListResponse.html @@ -1,5 +1,5 @@ AWSTagFilterListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AWSTagFilterListResponse

An array of tag filter rules by namespace and tag filter string.

-

Hierarchy

  • AWSTagFilterListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filters

filters?: AWSTagFilter[]
+

Hierarchy

  • AWSTagFilterListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filters

filters?: AWSTagFilter[]

An array of tag filters.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AlertGraphWidgetDefinition.html b/classes/v1.AlertGraphWidgetDefinition.html index 452be0b1b9e..25516a0a30d 100644 --- a/classes/v1.AlertGraphWidgetDefinition.html +++ b/classes/v1.AlertGraphWidgetDefinition.html @@ -1,9 +1,9 @@ AlertGraphWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlertGraphWidgetDefinition

Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.

-

Hierarchy

  • AlertGraphWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

alertId

alertId: string
+

Hierarchy

  • AlertGraphWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

alertId

alertId: string

ID of the alert to use in the widget.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

The title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "alert_graph"

vizType

vizType: WidgetVizType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "alert_graph"

vizType

vizType: WidgetVizType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AlertValueWidgetDefinition.html b/classes/v1.AlertValueWidgetDefinition.html index 90fed34dd27..4b3231f35d6 100644 --- a/classes/v1.AlertValueWidgetDefinition.html +++ b/classes/v1.AlertValueWidgetDefinition.html @@ -1,13 +1,13 @@ AlertValueWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlertValueWidgetDefinition

Alert values are query values showing the current value of the metric in any monitor defined on your system.

-

Hierarchy

  • AlertValueWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

alertId

alertId: string
+

Hierarchy

  • AlertValueWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

alertId

alertId: string

ID of the alert to use in the widget.

-

Optional precision

precision?: number
+

Optional precision

precision?: number

Number of decimal to show. If not defined, will use the raw value.

-

Optional textAlign

textAlign?: WidgetTextAlign

Optional title

title?: string
+

Optional textAlign

textAlign?: WidgetTextAlign

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of value in the widget.

-

type

type: "alert_value"

Optional unit

unit?: string
+

type

type: "alert_value"

Optional unit

unit?: string

Unit to display with the value.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApiException.html b/classes/v1.ApiException.html index 39a159e48d5..752beaacb28 100644 --- a/classes/v1.ApiException.html +++ b/classes/v1.ApiException.html @@ -4,7 +4,7 @@

Example API returns a ErrorMessageObject whenever HTTP status code is not in [200, 299] => ApiException(404, someErrorMessageObject)

-

Type parameters

  • T

Hierarchy

  • Error
    • ApiException

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: T

code

code: number

message

message: string

name

name: string

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • +

Type parameters

  • T

Hierarchy

  • Error
    • ApiException

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: T

code

code: number

message

message: string

name

name: string

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static Optional prepareStackTrace

  • prepareStackTrace(err: Error, stackTraces: CallSite[]): any

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApiKeyAuthQueryAuthentication.html b/classes/v1.ApiKeyAuthQueryAuthentication.html index 62c44cf7be1..9b3c9c21ccb 100644 --- a/classes/v1.ApiKeyAuthQueryAuthentication.html +++ b/classes/v1.ApiKeyAuthQueryAuthentication.html @@ -1,7 +1,7 @@ ApiKeyAuthQueryAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiKeyAuthQueryAuthentication

Applies apiKey authentication to the request context.

-

Hierarchy

  • ApiKeyAuthQueryAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • ApiKeyAuthQueryAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

applySecurityAuthentication

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApiKeyListResponse.html b/classes/v1.ApiKeyListResponse.html index 480f8c4d72e..fe3c6fc8a93 100644 --- a/classes/v1.ApiKeyListResponse.html +++ b/classes/v1.ApiKeyListResponse.html @@ -1,5 +1,5 @@ ApiKeyListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiKeyListResponse

List of API and application keys available for a given organization.

-

Hierarchy

  • ApiKeyListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKeys

apiKeys?: ApiKey[]
+

Hierarchy

  • ApiKeyListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKeys

apiKeys?: ApiKey[]

Array of API keys.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApiKeyResponse.html b/classes/v1.ApiKeyResponse.html index eeea7cfc2cb..71a2d3a2ad2 100644 --- a/classes/v1.ApiKeyResponse.html +++ b/classes/v1.ApiKeyResponse.html @@ -1,3 +1,3 @@ ApiKeyResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiKeyResponse

An API key with its associated metadata.

-

Hierarchy

  • ApiKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKey

apiKey?: ApiKey

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ApiKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKey

apiKey?: ApiKey

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApmStatsQueryColumnType.html b/classes/v1.ApmStatsQueryColumnType.html index f633d96840f..fd4250c9830 100644 --- a/classes/v1.ApmStatsQueryColumnType.html +++ b/classes/v1.ApmStatsQueryColumnType.html @@ -1,7 +1,7 @@ ApmStatsQueryColumnType | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApmStatsQueryColumnType

Column properties.

-

Hierarchy

  • ApmStatsQueryColumnType

Index

Constructors

Properties

Constructors

constructor

Properties

Optional alias

alias?: string
+

Hierarchy

  • ApmStatsQueryColumnType

Index

Constructors

Properties

Constructors

constructor

Properties

Optional alias

alias?: string

A user-assigned alias for the column.

-

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode

name

name: string
+

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode

name

name: string

Column name.

-

Optional order

order?: WidgetSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional order

order?: WidgetSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApmStatsQueryDefinition.html b/classes/v1.ApmStatsQueryDefinition.html index 2cad1ae8cca..3079fdff017 100644 --- a/classes/v1.ApmStatsQueryDefinition.html +++ b/classes/v1.ApmStatsQueryDefinition.html @@ -1,15 +1,15 @@ ApmStatsQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApmStatsQueryDefinition

The APM stats query for table and distributions widgets.

-

Hierarchy

  • ApmStatsQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional columns

columns?: ApmStatsQueryColumnType[]
+

Hierarchy

  • ApmStatsQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional columns

columns?: ApmStatsQueryColumnType[]

Column properties used by the front end for display.

-

env

env: string
+

env

env: string

Environment name.

-

name

name: string
+

name

name: string

Operation name associated with service.

-

primaryTag

primaryTag: string
+

primaryTag

primaryTag: string

The organization's host group name and value.

-

Optional resource

resource?: string
+

Optional resource

resource?: string

Resource name.

-

rowType

rowType: ApmStatsQueryRowType

service

service: string
+

rowType

rowType: ApmStatsQueryRowType

service

service: string

Service name.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AppKeyAuthAuthentication.html b/classes/v1.AppKeyAuthAuthentication.html index 55b3203f510..2bd98d998e4 100644 --- a/classes/v1.AppKeyAuthAuthentication.html +++ b/classes/v1.AppKeyAuthAuthentication.html @@ -1,7 +1,7 @@ AppKeyAuthAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppKeyAuthAuthentication

Applies apiKey authentication to the request context.

-

Hierarchy

  • AppKeyAuthAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • AppKeyAuthAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

applySecurityAuthentication

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AppKeyAuthQueryAuthentication.html b/classes/v1.AppKeyAuthQueryAuthentication.html index 6e2c4ddcda2..84bac9a458b 100644 --- a/classes/v1.AppKeyAuthQueryAuthentication.html +++ b/classes/v1.AppKeyAuthQueryAuthentication.html @@ -1,7 +1,7 @@ AppKeyAuthQueryAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppKeyAuthQueryAuthentication

Applies apiKey authentication to the request context.

-

Hierarchy

  • AppKeyAuthQueryAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • AppKeyAuthQueryAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

applySecurityAuthentication

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApplicationKey.html b/classes/v1.ApplicationKey.html index 4633a7f95cb..ec90d1275f3 100644 --- a/classes/v1.ApplicationKey.html +++ b/classes/v1.ApplicationKey.html @@ -1,9 +1,9 @@ ApplicationKey | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKey

An application key with its associated metadata.

-

Hierarchy

  • ApplicationKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hash

hash?: string
+

Hierarchy

  • ApplicationKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hash

hash?: string

Hash of an application key.

-

Optional name

name?: string
+

Optional name

name?: string

Name of an application key.

-

Optional owner

owner?: string
+

Optional owner

owner?: string

Owner of an application key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApplicationKeyListResponse.html b/classes/v1.ApplicationKeyListResponse.html index 3fefabbe91c..9ad45898e0d 100644 --- a/classes/v1.ApplicationKeyListResponse.html +++ b/classes/v1.ApplicationKeyListResponse.html @@ -1,5 +1,5 @@ ApplicationKeyListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyListResponse

An application key response.

-

Hierarchy

  • ApplicationKeyListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional applicationKeys

applicationKeys?: ApplicationKey[]
+

Hierarchy

  • ApplicationKeyListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional applicationKeys

applicationKeys?: ApplicationKey[]

Array of application keys.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApplicationKeyResponse.html b/classes/v1.ApplicationKeyResponse.html index 91d1d8d0214..6542648f45a 100644 --- a/classes/v1.ApplicationKeyResponse.html +++ b/classes/v1.ApplicationKeyResponse.html @@ -1,3 +1,3 @@ ApplicationKeyResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyResponse

An application key response.

-

Hierarchy

  • ApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional applicationKey

applicationKey?: ApplicationKey

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional applicationKey

applicationKey?: ApplicationKey

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AuthZAuthentication.html b/classes/v1.AuthZAuthentication.html index 3687223a4da..f90c07fc602 100644 --- a/classes/v1.AuthZAuthentication.html +++ b/classes/v1.AuthZAuthentication.html @@ -1,7 +1,7 @@ AuthZAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthZAuthentication

Applies oauth2 authentication to the request context.

-

Hierarchy

  • AuthZAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • AuthZAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

applySecurityAuthentication

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AuthenticationApi.html b/classes/v1.AuthenticationApi.html index 1d19e485a90..31d55a03ed6 100644 --- a/classes/v1.AuthenticationApi.html +++ b/classes/v1.AuthenticationApi.html @@ -1,3 +1,3 @@ -AuthenticationApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthenticationApi

Hierarchy

  • AuthenticationApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AuthenticationApi(configuration: v1.Configuration, requestFactory?: AuthenticationApiRequestFactory, responseProcessor?: AuthenticationApiResponseProcessor): AuthenticationApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: AuthenticationApiRequestFactory

Private responseProcessor

responseProcessor: AuthenticationApiResponseProcessor

Methods

validate

listAzureIntegration

updateAzureHostFilters

updateAzureHostFilters

updateAzureIntegration

Returns Promise<any>

updateAzureIntegration

setVariables

  • setVariables(variableConfiguration: {}): void

type

type: "change"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ChangeWidgetRequest.html b/classes/v1.ChangeWidgetRequest.html index 1cfb352c127..33ae1a29aac 100644 --- a/classes/v1.ChangeWidgetRequest.html +++ b/classes/v1.ChangeWidgetRequest.html @@ -1,13 +1,13 @@ ChangeWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChangeWidgetRequest

Updated change widget.

-

Hierarchy

  • ChangeWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional changeType

changeType?: WidgetChangeType

Optional compareTo

compareTo?: WidgetCompareTo

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]
+

Hierarchy

  • ChangeWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional changeType

changeType?: WidgetChangeType

Optional compareTo

compareTo?: WidgetCompareTo

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional increaseGood

increaseGood?: boolean
+

Optional increaseGood

increaseGood?: boolean

Whether to show increase as good.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional orderBy

orderBy?: WidgetOrderBy

Optional orderDir

orderDir?: WidgetSort

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional orderBy

orderBy?: WidgetOrderBy

Optional orderDir

orderDir?: WidgetSort

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Query definition.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional showPresent

showPresent?: boolean
+

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional showPresent

showPresent?: boolean

Whether to show the present value.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.CheckCanDeleteMonitorResponse.html b/classes/v1.CheckCanDeleteMonitorResponse.html index c7a55b4082d..138c06fdd6c 100644 --- a/classes/v1.CheckCanDeleteMonitorResponse.html +++ b/classes/v1.CheckCanDeleteMonitorResponse.html @@ -1,5 +1,5 @@ CheckCanDeleteMonitorResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckCanDeleteMonitorResponse

Response of monitor IDs that can or can't be safely deleted.

-

Hierarchy

  • CheckCanDeleteMonitorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: CheckCanDeleteMonitorResponseData

Optional errors

errors?: {}
+

Hierarchy

  • CheckCanDeleteMonitorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: CheckCanDeleteMonitorResponseData

Optional errors

errors?: {}

A mapping of Monitor ID to strings denoting where it's used.

Type declaration

  • [key: string]: string[]

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.CheckCanDeleteMonitorResponseData.html b/classes/v1.CheckCanDeleteMonitorResponseData.html index 60c8c855415..68ed20227da 100644 --- a/classes/v1.CheckCanDeleteMonitorResponseData.html +++ b/classes/v1.CheckCanDeleteMonitorResponseData.html @@ -1,5 +1,5 @@ CheckCanDeleteMonitorResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckCanDeleteMonitorResponseData

Wrapper object with the list of monitor IDs.

-

Hierarchy

  • CheckCanDeleteMonitorResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ok

ok?: number[]
+

Hierarchy

  • CheckCanDeleteMonitorResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ok

ok?: number[]

An array of of Monitor IDs that can be safely deleted.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.CheckCanDeleteSLOResponse.html b/classes/v1.CheckCanDeleteSLOResponse.html index 01ced25f5b0..fda57142ded 100644 --- a/classes/v1.CheckCanDeleteSLOResponse.html +++ b/classes/v1.CheckCanDeleteSLOResponse.html @@ -1,5 +1,5 @@ CheckCanDeleteSLOResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckCanDeleteSLOResponse

A service level objective response containing the requested object.

-

Hierarchy

  • CheckCanDeleteSLOResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: CheckCanDeleteSLOResponseData

Optional errors

errors?: {}
+

Hierarchy

  • CheckCanDeleteSLOResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: CheckCanDeleteSLOResponseData

Optional errors

errors?: {}

A mapping of SLO id to it's current usages.

Type declaration

  • [key: string]: string

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.CheckCanDeleteSLOResponseData.html b/classes/v1.CheckCanDeleteSLOResponseData.html index 0fd50290432..06bfd2dccd8 100644 --- a/classes/v1.CheckCanDeleteSLOResponseData.html +++ b/classes/v1.CheckCanDeleteSLOResponseData.html @@ -1,5 +1,5 @@ CheckCanDeleteSLOResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckCanDeleteSLOResponseData

An array of service level objective objects.

-

Hierarchy

  • CheckCanDeleteSLOResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ok

ok?: string[]
+

Hierarchy

  • CheckCanDeleteSLOResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ok

ok?: string[]

An array of of SLO IDs that can be safely deleted.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.CheckStatusWidgetDefinition.html b/classes/v1.CheckStatusWidgetDefinition.html index 114dafc15ed..e209e9df017 100644 --- a/classes/v1.CheckStatusWidgetDefinition.html +++ b/classes/v1.CheckStatusWidgetDefinition.html @@ -1,15 +1,15 @@ CheckStatusWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CheckStatusWidgetDefinition

Check status shows the current status or number of results for any check performed.

-

Hierarchy

  • CheckStatusWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

check

check: string
+

Hierarchy

  • CheckStatusWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

check

check: string

Name of the check to use in the widget.

-

Optional group

group?: string
+

Optional group

group?: string

Group reporting a single check.

-

Optional groupBy

groupBy?: string[]
+

Optional groupBy

groupBy?: string[]

List of tag prefixes to group by in the case of a cluster check.

-

grouping

grouping: WidgetGrouping

Optional tags

tags?: string[]
+

grouping

grouping: WidgetGrouping

Optional tags

tags?: string[]

List of tags used to filter the groups reporting a cluster check.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "check_status"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "check_status"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Creator.html b/classes/v1.Creator.html index 0aad857b594..89a61affc94 100644 --- a/classes/v1.Creator.html +++ b/classes/v1.Creator.html @@ -1,9 +1,9 @@ Creator | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Creator

Object describing the creator of the shared element.

-

Hierarchy

  • Creator

Index

Constructors

Properties

Constructors

constructor

Properties

Optional email

email?: string
+

Hierarchy

  • Creator

Index

Constructors

Properties

Constructors

constructor

Properties

Optional email

email?: string

Email of the creator.

-

Optional handle

handle?: string
+

Optional handle

handle?: string

Handle of the creator.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the creator.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Dashboard.html b/classes/v1.Dashboard.html index 83a7fd63fd8..76d61f649de 100644 --- a/classes/v1.Dashboard.html +++ b/classes/v1.Dashboard.html @@ -1,31 +1,31 @@ Dashboard | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dashboard

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

-

Hierarchy

  • Dashboard

Index

Constructors

Properties

Constructors

constructor

Properties

Optional authorHandle

authorHandle?: string
+

Hierarchy

  • Dashboard

Index

Constructors

Properties

Constructors

constructor

Properties

Optional authorHandle

authorHandle?: string

Identifier of the dashboard author.

-

Optional authorName

authorName?: string
+

Optional authorName

authorName?: string

Name of the dashboard author.

-

Optional createdAt

createdAt?: Date
+

Optional createdAt

createdAt?: Date

Creation date of the dashboard.

-

Optional description

description?: string
+

Optional description

description?: string

Description of the dashboard.

-

Optional id

id?: string
+

Optional id

id?: string

ID of the dashboard.

-

Optional isReadOnly

isReadOnly?: boolean
+

Optional isReadOnly

isReadOnly?: boolean

Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.

-

layoutType

layoutType: DashboardLayoutType

Optional modifiedAt

modifiedAt?: Date
+

layoutType

layoutType: DashboardLayoutType

Optional modifiedAt

modifiedAt?: Date

Modification date of the dashboard.

-

Optional notifyList

notifyList?: string[]
+

Optional notifyList

notifyList?: string[]

List of handles of users to notify when changes are made to this dashboard.

-

Optional reflowType

reflowType?: DashboardReflowType

Optional restrictedRoles

restrictedRoles?: string[]
+

Optional reflowType

reflowType?: DashboardReflowType

Optional restrictedRoles

restrictedRoles?: string[]

A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.

-

Optional templateVariablePresets

templateVariablePresets?: DashboardTemplateVariablePreset[]
+

Optional templateVariablePresets

templateVariablePresets?: DashboardTemplateVariablePreset[]

Array of template variables saved views.

-

Optional templateVariables

templateVariables?: DashboardTemplateVariable[]
+

Optional templateVariables

templateVariables?: DashboardTemplateVariable[]

List of template variables for this dashboard.

-

title

title: string
+

title

title: string

Title of the dashboard.

-

Optional url

url?: string
+

Optional url

url?: string

The URL of the dashboard.

-

widgets

widgets: Widget[]
+

widgets

widgets: Widget[]

List of widgets to display on the dashboard.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardBulkActionData.html b/classes/v1.DashboardBulkActionData.html index 20fb7037b9d..b7f1faad8ee 100644 --- a/classes/v1.DashboardBulkActionData.html +++ b/classes/v1.DashboardBulkActionData.html @@ -1,5 +1,5 @@ DashboardBulkActionData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardBulkActionData

Dashboard bulk action request data.

-

Hierarchy

  • DashboardBulkActionData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string
+

Hierarchy

  • DashboardBulkActionData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string

Dashboard resource ID.

-

type

type: "dashboard"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "dashboard"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardBulkDeleteRequest.html b/classes/v1.DashboardBulkDeleteRequest.html index 93df0423d7a..7170be6dbca 100644 --- a/classes/v1.DashboardBulkDeleteRequest.html +++ b/classes/v1.DashboardBulkDeleteRequest.html @@ -1,5 +1,5 @@ DashboardBulkDeleteRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardBulkDeleteRequest

Dashboard bulk delete request body.

-

Hierarchy

  • DashboardBulkDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: DashboardBulkActionData[]
+

Hierarchy

  • DashboardBulkDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: DashboardBulkActionData[]

List of dashboard bulk action request data objects.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardDeleteResponse.html b/classes/v1.DashboardDeleteResponse.html index 8b3f0124ad9..d8b9244cacb 100644 --- a/classes/v1.DashboardDeleteResponse.html +++ b/classes/v1.DashboardDeleteResponse.html @@ -1,5 +1,5 @@ DashboardDeleteResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardDeleteResponse

Response from the delete dashboard call.

-

Hierarchy

  • DashboardDeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedDashboardId

deletedDashboardId?: string
+

Hierarchy

  • DashboardDeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedDashboardId

deletedDashboardId?: string

ID of the deleted dashboard.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardList.html b/classes/v1.DashboardList.html index 809698415d8..d8b301e0de5 100644 --- a/classes/v1.DashboardList.html +++ b/classes/v1.DashboardList.html @@ -1,17 +1,17 @@ DashboardList | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardList

Your Datadog Dashboards.

-

Hierarchy

  • DashboardList

Index

Constructors

Properties

Constructors

constructor

Properties

Optional author

author?: v1.Creator

Optional created

created?: Date
+

Hierarchy

  • DashboardList

Index

Constructors

Properties

Constructors

constructor

Properties

Optional author

author?: v1.Creator

Optional created

created?: Date

Date of creation of the dashboard list.

-

Optional dashboardCount

dashboardCount?: number
+

Optional dashboardCount

dashboardCount?: number

The number of dashboards in the list.

-

Optional id

id?: number
+

Optional id

id?: number

The ID of the dashboard list.

-

Optional isFavorite

isFavorite?: boolean
+

Optional isFavorite

isFavorite?: boolean

Whether or not the list is in the favorites.

-

Optional modified

modified?: Date
+

Optional modified

modified?: Date

Date of last edition of the dashboard list.

-

name

name: string
+

name

name: string

The name of the dashboard list.

-

Optional type

type?: string
+

Optional type

type?: string

The type of dashboard list.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardListDeleteResponse.html b/classes/v1.DashboardListDeleteResponse.html index 4aed5043d40..38c0bd8055c 100644 --- a/classes/v1.DashboardListDeleteResponse.html +++ b/classes/v1.DashboardListDeleteResponse.html @@ -1,5 +1,5 @@ DashboardListDeleteResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListDeleteResponse

Deleted dashboard details.

-

Hierarchy

  • DashboardListDeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedDashboardListId

deletedDashboardListId?: number
+

Hierarchy

  • DashboardListDeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedDashboardListId

deletedDashboardListId?: number

ID of the deleted dashboard list.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardListListResponse.html b/classes/v1.DashboardListListResponse.html index a3544f5eb3b..aee2ac7a6ff 100644 --- a/classes/v1.DashboardListListResponse.html +++ b/classes/v1.DashboardListListResponse.html @@ -1,5 +1,5 @@ DashboardListListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListListResponse

Information on your dashboard lists.

-

Hierarchy

  • DashboardListListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dashboardLists

dashboardLists?: DashboardList[]
+

Hierarchy

  • DashboardListListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dashboardLists

dashboardLists?: DashboardList[]

List of all your dashboard lists.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DashboardListsApi.html b/classes/v1.DashboardListsApi.html index 312db06fd29..d4b8532b9cd 100644 --- a/classes/v1.DashboardListsApi.html +++ b/classes/v1.DashboardListsApi.html @@ -1,18 +1,18 @@ -DashboardListsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListsApi

Hierarchy

  • DashboardListsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DashboardListsApi(configuration: v1.Configuration, requestFactory?: DashboardListsApiRequestFactory, responseProcessor?: DashboardListsApiResponseProcessor): v1.DashboardListsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: DashboardListsApiRequestFactory

Private responseProcessor

responseProcessor: DashboardListsApiResponseProcessor

Methods

createDashboardList

deleteDashboardList

getDashboardList

Returns Promise<DashboardListDeleteResponse>

getDashboardList

listDashboardLists

Returns Promise<DashboardList>

listDashboardLists

updateDashboardList

updateDashboardList

deleteDashboards

getDashboard

Returns Promise<void>

getDashboard

listDashboards

Returns Promise<Dashboard>

listDashboards

restoreDashboards

Returns Promise<DashboardSummary>

restoreDashboards

updateDashboard

Returns Promise<void>

updateDashboard

type

type: "distribution"

Optional xaxis

xaxis?: DistributionWidgetXAxis

Optional yaxis

yaxis?: DistributionWidgetYAxis

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DistributionWidgetRequest.html b/classes/v1.DistributionWidgetRequest.html index c31b7be19f1..54c88d7eb49 100644 --- a/classes/v1.DistributionWidgetRequest.html +++ b/classes/v1.DistributionWidgetRequest.html @@ -1,5 +1,5 @@ DistributionWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DistributionWidgetRequest

Updated distribution widget.

-

Hierarchy

  • DistributionWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional apmStatsQuery

apmStatsQuery?: ApmStatsQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Hierarchy

  • DistributionWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional apmStatsQuery

apmStatsQuery?: ApmStatsQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Widget query.

-

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DistributionWidgetXAxis.html b/classes/v1.DistributionWidgetXAxis.html index 81976116e76..57e2e75e204 100644 --- a/classes/v1.DistributionWidgetXAxis.html +++ b/classes/v1.DistributionWidgetXAxis.html @@ -1,11 +1,11 @@ DistributionWidgetXAxis | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DistributionWidgetXAxis

X Axis controls for the distribution widget.

-

Hierarchy

  • DistributionWidgetXAxis

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeZero

includeZero?: boolean
+

Hierarchy

  • DistributionWidgetXAxis

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeZero

includeZero?: boolean

True includes zero.

-

Optional max

max?: string
+

Optional max

max?: string

Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.

-

Optional min

min?: string
+

Optional min

min?: string

Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.

-

Optional scale

scale?: string
+

Optional scale

scale?: string

Specifies the scale type. Possible values are linear.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DistributionWidgetYAxis.html b/classes/v1.DistributionWidgetYAxis.html index 22389d1f298..5d3fa94803c 100644 --- a/classes/v1.DistributionWidgetYAxis.html +++ b/classes/v1.DistributionWidgetYAxis.html @@ -1,13 +1,13 @@ DistributionWidgetYAxis | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DistributionWidgetYAxis

Y Axis controls for the distribution widget.

-

Hierarchy

  • DistributionWidgetYAxis

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeZero

includeZero?: boolean
+

Hierarchy

  • DistributionWidgetYAxis

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeZero

includeZero?: boolean

True includes zero.

-

Optional label

label?: string
+

Optional label

label?: string

The label of the axis to display on the graph.

-

Optional max

max?: string
+

Optional max

max?: string

Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.

-

Optional min

min?: string
+

Optional min

min?: string

Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.

-

Optional scale

scale?: string
+

Optional scale

scale?: string

Specifies the scale type. Possible values are linear or log.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Downtime.html b/classes/v1.Downtime.html index a1e303e3ff0..101bf246291 100644 --- a/classes/v1.Downtime.html +++ b/classes/v1.Downtime.html @@ -1,33 +1,33 @@ Downtime | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Downtime

Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.

-

Hierarchy

  • Downtime

Index

Constructors

Properties

Constructors

constructor

Properties

Optional active

active?: boolean
+

Hierarchy

  • Downtime

Index

Constructors

Properties

Constructors

constructor

Properties

Optional active

active?: boolean

If a scheduled downtime currently exists.

-

Optional activeChild

activeChild?: DowntimeChild

Optional canceled

canceled?: number
+

Optional activeChild

activeChild?: DowntimeChild

Optional canceled

canceled?: number

If a scheduled downtime is canceled.

-

Optional creatorId

creatorId?: number
+

Optional creatorId

creatorId?: number

User ID of the downtime creator.

-

Optional disabled

disabled?: boolean
+

Optional disabled

disabled?: boolean

If a downtime has been disabled.

-

Optional downtimeType

downtimeType?: number
+

Optional downtimeType

downtimeType?: number

0 for a downtime applied on * or all, 1 when the downtime is only scoped to hosts, or 2 when the downtime is scoped to anything but hosts.

-

Optional end

end?: number
+

Optional end

end?: number

POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.

-

Optional id

id?: number
+

Optional id

id?: number

The downtime ID.

-

Optional message

message?: string
+

Optional message

message?: string

A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.

-

Optional monitorId

monitorId?: number
+

Optional monitorId

monitorId?: number

A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.

-

Optional monitorTags

monitorTags?: string[]
+

Optional monitorTags

monitorTags?: string[]

A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, service:postgres AND team:frontend.

-

Optional parentId

parentId?: number
+

Optional parentId

parentId?: number

ID of the parent Downtime.

-

Optional recurrence

recurrence?: DowntimeRecurrence

Optional scope

scope?: string[]
+

Optional recurrence

recurrence?: DowntimeRecurrence

Optional scope

scope?: string[]

The scope(s) to which the downtime applies. For example, host:app2. Provide multiple scopes as a comma-separated list like env:dev,env:prod. The resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

-

Optional start

start?: number
+

Optional start

start?: number

POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.

-

Optional timezone

timezone?: string
+

Optional timezone

timezone?: string

The timezone in which to display the downtime's start and end times in Datadog applications.

-

Optional updaterId

updaterId?: number
+

Optional updaterId

updaterId?: number

ID of the last user that updated the downtime.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DowntimeChild.html b/classes/v1.DowntimeChild.html index a0be38f1578..9d76b5b9f73 100644 --- a/classes/v1.DowntimeChild.html +++ b/classes/v1.DowntimeChild.html @@ -1,33 +1,33 @@ DowntimeChild | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DowntimeChild

The downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.

-

Hierarchy

  • DowntimeChild

Index

Constructors

Properties

Constructors

constructor

Properties

Optional active

active?: boolean
+

Hierarchy

  • DowntimeChild

Index

Constructors

Properties

Constructors

constructor

Properties

Optional active

active?: boolean

If a scheduled downtime currently exists.

-

Optional canceled

canceled?: number
+

Optional canceled

canceled?: number

If a scheduled downtime is canceled.

-

Optional creatorId

creatorId?: number
+

Optional creatorId

creatorId?: number

User ID of the downtime creator.

-

Optional disabled

disabled?: boolean
+

Optional disabled

disabled?: boolean

If a downtime has been disabled.

-

Optional downtimeType

downtimeType?: number
+

Optional downtimeType

downtimeType?: number

0 for a downtime applied on * or all, 1 when the downtime is only scoped to hosts, or 2 when the downtime is scoped to anything but hosts.

-

Optional end

end?: number
+

Optional end

end?: number

POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.

-

Optional id

id?: number
+

Optional id

id?: number

The downtime ID.

-

Optional message

message?: string
+

Optional message

message?: string

A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.

-

Optional monitorId

monitorId?: number
+

Optional monitorId

monitorId?: number

A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.

-

Optional monitorTags

monitorTags?: string[]
+

Optional monitorTags

monitorTags?: string[]

A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, service:postgres AND team:frontend.

-

Optional parentId

parentId?: number
+

Optional parentId

parentId?: number

ID of the parent Downtime.

-

Optional recurrence

recurrence?: DowntimeRecurrence

Optional scope

scope?: string[]
+

Optional recurrence

recurrence?: DowntimeRecurrence

Optional scope

scope?: string[]

The scope(s) to which the downtime applies. For example, host:app2. Provide multiple scopes as a comma-separated list like env:dev,env:prod. The resulting downtime applies to sources that matches ALL provided scopes (env:dev AND env:prod).

-

Optional start

start?: number
+

Optional start

start?: number

POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.

-

Optional timezone

timezone?: string
+

Optional timezone

timezone?: string

The timezone in which to display the downtime's start and end times in Datadog applications.

-

Optional updaterId

updaterId?: number
+

Optional updaterId

updaterId?: number

ID of the last user that updated the downtime.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DowntimeRecurrence.html b/classes/v1.DowntimeRecurrence.html index 9045a983ead..1c304cb4488 100644 --- a/classes/v1.DowntimeRecurrence.html +++ b/classes/v1.DowntimeRecurrence.html @@ -1,15 +1,15 @@ DowntimeRecurrence | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DowntimeRecurrence

An object defining the recurrence of the downtime.

-

Hierarchy

  • DowntimeRecurrence

Index

Constructors

Properties

Constructors

constructor

Properties

Optional period

period?: number
+

Hierarchy

  • DowntimeRecurrence

Index

Constructors

Properties

Constructors

constructor

Properties

Optional period

period?: number

How often to repeat as an integer. For example, to repeat every 3 days, select a type of days and a period of 3.

-

Optional rrule

rrule?: string
+

Optional rrule

rrule?: string

The RRULE standard for defining recurring events (requires to set "type" to rrule) For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1. Most common rrule options from the iCalendar Spec are supported. Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION). More examples available in this downtime guide

-

Optional type

type?: string
+

Optional type

type?: string

The type of recurrence. Choose from days, weeks, months, years, rrule.

-

Optional untilDate

untilDate?: number
+

Optional untilDate

untilDate?: number

The date at which the recurrence should end as a POSIX timestamp. until_occurences and until_date are mutually exclusive.

-

Optional untilOccurrences

untilOccurrences?: number
+

Optional untilOccurrences

untilOccurrences?: number

How many times the downtime is rescheduled. until_occurences and until_date are mutually exclusive.

-

Optional weekDays

weekDays?: string[]
+

Optional weekDays

weekDays?: string[]

A list of week days to repeat on. Choose from Mon, Tue, Wed, Thu, Fri, Sat or Sun. Only applicable when type is weeks. First letter must be capitalized.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DowntimesApi.html b/classes/v1.DowntimesApi.html index 59ddbff7064..cb18ee75d5d 100644 --- a/classes/v1.DowntimesApi.html +++ b/classes/v1.DowntimesApi.html @@ -1,28 +1,28 @@ -DowntimesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DowntimesApi

Hierarchy

  • DowntimesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DowntimesApi(configuration: v1.Configuration, requestFactory?: DowntimesApiRequestFactory, responseProcessor?: DowntimesApiResponseProcessor): DowntimesApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: DowntimesApiRequestFactory

Private responseProcessor

responseProcessor: DowntimesApiResponseProcessor

Methods

cancelDowntime

cancelDowntimesByScope

createDowntime

Returns Promise<CanceledDowntimesIds>

createDowntime

getDowntime

Returns Promise<Downtime>

getDowntime

listDowntimes

Returns Promise<Downtime>

listDowntimes

listMonitorDowntimes

Returns Promise<Downtime[]>

listMonitorDowntimes

updateDowntime

Returns Promise<Downtime[]>

updateDowntime

type

type: "event_stream"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.EventTimelineWidgetDefinition.html b/classes/v1.EventTimelineWidgetDefinition.html index cec2d7cb36b..815a3f94162 100644 --- a/classes/v1.EventTimelineWidgetDefinition.html +++ b/classes/v1.EventTimelineWidgetDefinition.html @@ -1,11 +1,11 @@ EventTimelineWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventTimelineWidgetDefinition

The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards.

-

Hierarchy

  • EventTimelineWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string
+

Hierarchy

  • EventTimelineWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string

Query to filter the event timeline with.

-

Optional tagsExecution

tagsExecution?: string
+

Optional tagsExecution

tagsExecution?: string

The execution method for multi-value filters. Can be either and or or.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "event_timeline"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "event_timeline"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.EventsApi.html b/classes/v1.EventsApi.html index 065b53e6980..30a1638d328 100644 --- a/classes/v1.EventsApi.html +++ b/classes/v1.EventsApi.html @@ -1,12 +1,12 @@ -EventsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventsApi

Hierarchy

  • EventsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new EventsApi(configuration: v1.Configuration, requestFactory?: EventsApiRequestFactory, responseProcessor?: EventsApiResponseProcessor): EventsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: EventsApiRequestFactory

Private responseProcessor

responseProcessor: EventsApiResponseProcessor

Methods

createEvent

getEvent

listEvents

Returns Promise<EventResponse>

listEvents

stat

stat: FormulaAndFunctionApmDependencyStatName

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionApmResourceStatsQueryDefinition.html b/classes/v1.FormulaAndFunctionApmResourceStatsQueryDefinition.html index c49d959c4ea..318aaca2f28 100644 --- a/classes/v1.FormulaAndFunctionApmResourceStatsQueryDefinition.html +++ b/classes/v1.FormulaAndFunctionApmResourceStatsQueryDefinition.html @@ -1,19 +1,19 @@ FormulaAndFunctionApmResourceStatsQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionApmResourceStatsQueryDefinition

APM resource stats query using formulas and functions.

-

Hierarchy

  • FormulaAndFunctionApmResourceStatsQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

dataSource

dataSource: "apm_resource_stats"

env

env: string
+

Hierarchy

  • FormulaAndFunctionApmResourceStatsQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

dataSource

dataSource: "apm_resource_stats"

env

env: string

APM environment.

-

Optional groupBy

groupBy?: string[]
+

Optional groupBy

groupBy?: string[]

Array of fields to group results by.

-

name

name: string
+

name

name: string

Name of this query to use in formulas.

-

Optional operationName

operationName?: string
+

Optional operationName

operationName?: string

Name of operation on service.

-

Optional primaryTagName

primaryTagName?: string
+

Optional primaryTagName

primaryTagName?: string

Name of the second primary tag used within APM. Required when primary_tag_value is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

-

Optional primaryTagValue

primaryTagValue?: string
+

Optional primaryTagValue

primaryTagValue?: string

Value of the second primary tag by which to filter APM data. primary_tag_name must also be specified.

-

Optional resourceName

resourceName?: string
+

Optional resourceName

resourceName?: string

APM resource name.

-

service

service: string
+

service

service: string

APM service name.

-

stat

stat: FormulaAndFunctionApmResourceStatName

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

stat

stat: FormulaAndFunctionApmResourceStatName

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionEventQueryDefinition.html b/classes/v1.FormulaAndFunctionEventQueryDefinition.html index b325f07f98e..085b18735dc 100644 --- a/classes/v1.FormulaAndFunctionEventQueryDefinition.html +++ b/classes/v1.FormulaAndFunctionEventQueryDefinition.html @@ -1,9 +1,9 @@ FormulaAndFunctionEventQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionEventQueryDefinition

A formula and functions events query.

-

Hierarchy

  • FormulaAndFunctionEventQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

compute

compute: FormulaAndFunctionEventQueryDefinitionCompute

dataSource

dataSource: FormulaAndFunctionEventsDataSource

Optional groupBy

groupBy?: FormulaAndFunctionEventQueryGroupBy[]
+

Hierarchy

  • FormulaAndFunctionEventQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

compute

compute: FormulaAndFunctionEventQueryDefinitionCompute

dataSource

dataSource: FormulaAndFunctionEventsDataSource

Optional groupBy

groupBy?: FormulaAndFunctionEventQueryGroupBy[]

Group by options.

-

Optional indexes

indexes?: string[]
+

Optional indexes

indexes?: string[]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

-

name

name: string
+

name

name: string

Name of the query for use in formulas.

-

Optional search

search?: FormulaAndFunctionEventQueryDefinitionSearch

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional search

search?: FormulaAndFunctionEventQueryDefinitionSearch

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionEventQueryDefinitionCompute.html b/classes/v1.FormulaAndFunctionEventQueryDefinitionCompute.html index b638bff4a10..70eac8b0d66 100644 --- a/classes/v1.FormulaAndFunctionEventQueryDefinitionCompute.html +++ b/classes/v1.FormulaAndFunctionEventQueryDefinitionCompute.html @@ -1,7 +1,7 @@ FormulaAndFunctionEventQueryDefinitionCompute | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionEventQueryDefinitionCompute

Compute options.

-

Hierarchy

  • FormulaAndFunctionEventQueryDefinitionCompute

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: FormulaAndFunctionEventAggregation

Optional interval

interval?: number
+

Hierarchy

  • FormulaAndFunctionEventQueryDefinitionCompute

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: FormulaAndFunctionEventAggregation

Optional interval

interval?: number

A time interval in milliseconds.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

Measurable attribute to compute.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionEventQueryDefinitionSearch.html b/classes/v1.FormulaAndFunctionEventQueryDefinitionSearch.html index 9100c6187f3..96ad238ced1 100644 --- a/classes/v1.FormulaAndFunctionEventQueryDefinitionSearch.html +++ b/classes/v1.FormulaAndFunctionEventQueryDefinitionSearch.html @@ -1,5 +1,5 @@ FormulaAndFunctionEventQueryDefinitionSearch | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionEventQueryDefinitionSearch

Search options.

-

Hierarchy

  • FormulaAndFunctionEventQueryDefinitionSearch

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string
+

Hierarchy

  • FormulaAndFunctionEventQueryDefinitionSearch

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string

Events search string.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionEventQueryGroupBy.html b/classes/v1.FormulaAndFunctionEventQueryGroupBy.html index def40e043ba..2998430c072 100644 --- a/classes/v1.FormulaAndFunctionEventQueryGroupBy.html +++ b/classes/v1.FormulaAndFunctionEventQueryGroupBy.html @@ -1,7 +1,7 @@ FormulaAndFunctionEventQueryGroupBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionEventQueryGroupBy

List of objects used to group by.

-

Hierarchy

  • FormulaAndFunctionEventQueryGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string
+

Hierarchy

  • FormulaAndFunctionEventQueryGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string

Event facet.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Number of groups to return.

-

Optional sort

sort?: FormulaAndFunctionEventQueryGroupBySort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional sort

sort?: FormulaAndFunctionEventQueryGroupBySort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionEventQueryGroupBySort.html b/classes/v1.FormulaAndFunctionEventQueryGroupBySort.html index a0c67be2064..39d21e2c934 100644 --- a/classes/v1.FormulaAndFunctionEventQueryGroupBySort.html +++ b/classes/v1.FormulaAndFunctionEventQueryGroupBySort.html @@ -1,5 +1,5 @@ FormulaAndFunctionEventQueryGroupBySort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionEventQueryGroupBySort

Options for sorting group by results.

-

Hierarchy

  • FormulaAndFunctionEventQueryGroupBySort

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: FormulaAndFunctionEventAggregation

Optional metric

metric?: string
+

Hierarchy

  • FormulaAndFunctionEventQueryGroupBySort

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: FormulaAndFunctionEventAggregation

Optional metric

metric?: string

Metric used for sorting group by results.

-

Optional order

order?: v1.QuerySortOrder

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional order

order?: v1.QuerySortOrder

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionMetricQueryDefinition.html b/classes/v1.FormulaAndFunctionMetricQueryDefinition.html index 8cf59a88d11..b6a14aa248f 100644 --- a/classes/v1.FormulaAndFunctionMetricQueryDefinition.html +++ b/classes/v1.FormulaAndFunctionMetricQueryDefinition.html @@ -1,7 +1,7 @@ FormulaAndFunctionMetricQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionMetricQueryDefinition

A formula and functions metrics query.

-

Hierarchy

  • FormulaAndFunctionMetricQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: FormulaAndFunctionMetricAggregation

dataSource

dataSource: "metrics"

name

name: string
+

Hierarchy

  • FormulaAndFunctionMetricQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: FormulaAndFunctionMetricAggregation

dataSource

dataSource: "metrics"

name

name: string

Name of the query for use in formulas.

-

query

query: string
+

query

query: string

Metrics query definition.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FormulaAndFunctionProcessQueryDefinition.html b/classes/v1.FormulaAndFunctionProcessQueryDefinition.html index f542589f2f8..5b0a1834dd5 100644 --- a/classes/v1.FormulaAndFunctionProcessQueryDefinition.html +++ b/classes/v1.FormulaAndFunctionProcessQueryDefinition.html @@ -1,15 +1,15 @@ FormulaAndFunctionProcessQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormulaAndFunctionProcessQueryDefinition

Process query using formulas and functions.

-

Hierarchy

  • FormulaAndFunctionProcessQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: FormulaAndFunctionMetricAggregation

dataSource

dataSource: FormulaAndFunctionProcessQueryDataSource

Optional isNormalizedCpu

isNormalizedCpu?: boolean
+

Hierarchy

  • FormulaAndFunctionProcessQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: FormulaAndFunctionMetricAggregation

dataSource

dataSource: FormulaAndFunctionProcessQueryDataSource

Optional isNormalizedCpu

isNormalizedCpu?: boolean

Whether to normalize the CPU percentages.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Number of hits to return.

-

metric

metric: string
+

metric

metric: string

Process metric name.

-

name

name: string
+

name

name: string

Name of query for use in formulas.

-

Optional sort

sort?: v1.QuerySortOrder

Optional tagFilters

tagFilters?: string[]
+

Optional sort

sort?: v1.QuerySortOrder

Optional tagFilters

tagFilters?: string[]

An array of tags to filter by.

-

Optional textFilter

textFilter?: string
+

Optional textFilter

textFilter?: string

Text to use as filter.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FreeTextWidgetDefinition.html b/classes/v1.FreeTextWidgetDefinition.html index 8fe4a87ccfd..9cdb28a9714 100644 --- a/classes/v1.FreeTextWidgetDefinition.html +++ b/classes/v1.FreeTextWidgetDefinition.html @@ -1,9 +1,9 @@ FreeTextWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FreeTextWidgetDefinition

Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.

-

Hierarchy

  • FreeTextWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional color

color?: string
+

Hierarchy

  • FreeTextWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional color

color?: string

Color of the text.

-

Optional fontSize

fontSize?: string
+

Optional fontSize

fontSize?: string

Size of the text.

-

text

text: string
+

text

text: string

Text to display.

-

Optional textAlign

textAlign?: WidgetTextAlign

type

type: "free_text"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional textAlign

textAlign?: WidgetTextAlign

type

type: "free_text"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FunnelQuery.html b/classes/v1.FunnelQuery.html index 2e439731c2a..5aece1fc48d 100644 --- a/classes/v1.FunnelQuery.html +++ b/classes/v1.FunnelQuery.html @@ -1,7 +1,7 @@ FunnelQuery | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FunnelQuery

Updated funnel widget.

-

Hierarchy

  • FunnelQuery

Index

Constructors

Properties

Constructors

constructor

Properties

dataSource

dataSource: "rum"

queryString

queryString: string
+

Hierarchy

  • FunnelQuery

Index

Constructors

Properties

Constructors

constructor

Properties

dataSource

dataSource: "rum"

queryString

queryString: string

The widget query.

-

steps

steps: FunnelStep[]
+

steps

steps: FunnelStep[]

List of funnel steps.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FunnelStep.html b/classes/v1.FunnelStep.html index 4cc69ef2d68..9e3663c546a 100644 --- a/classes/v1.FunnelStep.html +++ b/classes/v1.FunnelStep.html @@ -1,7 +1,7 @@ FunnelStep | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FunnelStep

The funnel step.

-

Hierarchy

  • FunnelStep

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string
+

Hierarchy

  • FunnelStep

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string

The facet of the step.

-

value

value: string
+

value

value: string

The value of the step.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FunnelWidgetDefinition.html b/classes/v1.FunnelWidgetDefinition.html index 2db1d71fc8d..ffd6c7170e6 100644 --- a/classes/v1.FunnelWidgetDefinition.html +++ b/classes/v1.FunnelWidgetDefinition.html @@ -1,9 +1,9 @@ FunnelWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FunnelWidgetDefinition

The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.

-

Hierarchy

  • FunnelWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

requests

requests: FunnelWidgetRequest[]
+

Hierarchy

  • FunnelWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

requests

requests: FunnelWidgetRequest[]

Request payload used to query items.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

The title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

The size of the title.

-

type

type: "funnel"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "funnel"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.FunnelWidgetRequest.html b/classes/v1.FunnelWidgetRequest.html index bf16ba06fc0..6a3ac88a9ae 100644 --- a/classes/v1.FunnelWidgetRequest.html +++ b/classes/v1.FunnelWidgetRequest.html @@ -1,3 +1,3 @@ FunnelWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FunnelWidgetRequest

Updated funnel widget.

-

Hierarchy

  • FunnelWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: FunnelQuery

requestType

requestType: "funnel"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • FunnelWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: FunnelQuery

requestType

requestType: "funnel"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GCPAccount.html b/classes/v1.GCPAccount.html index 4a5a8303d16..78d489048ab 100644 --- a/classes/v1.GCPAccount.html +++ b/classes/v1.GCPAccount.html @@ -1,29 +1,29 @@ GCPAccount | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GCPAccount

Your Google Cloud Platform Account.

-

Hierarchy

  • GCPAccount

Index

Constructors

Properties

Constructors

constructor

Properties

Optional authProviderX509CertUrl

authProviderX509CertUrl?: string
+

Hierarchy

  • GCPAccount

Index

Constructors

Properties

Constructors

constructor

Properties

Optional authProviderX509CertUrl

authProviderX509CertUrl?: string

Should be https://www.googleapis.com/oauth2/v1/certs.

-

Optional authUri

authUri?: string
+

Optional authUri

authUri?: string

Should be https://accounts.google.com/o/oauth2/auth.

-

Optional automute

automute?: boolean
+

Optional automute

automute?: boolean

Silence monitors for expected GCE instance shutdowns.

-

Optional clientEmail

clientEmail?: string
+

Optional clientEmail

clientEmail?: string

Your email found in your JSON service account key.

-

Optional clientId

clientId?: string
+

Optional clientId

clientId?: string

Your ID found in your JSON service account key.

-

Optional clientX509CertUrl

clientX509CertUrl?: string
+

Optional clientX509CertUrl

clientX509CertUrl?: string

Should be https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL> where <CLIENT_EMAIL> is the email found in your JSON service account key.

-

Optional errors

errors?: string[]
+

Optional errors

errors?: string[]

An array of errors.

-

Optional hostFilters

hostFilters?: string
+

Optional hostFilters

hostFilters?: string

Limit the GCE instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog.

-

Optional privateKey

privateKey?: string
+

Optional privateKey

privateKey?: string

Your private key name found in your JSON service account key.

-

Optional privateKeyId

privateKeyId?: string
+

Optional privateKeyId

privateKeyId?: string

Your private key ID found in your JSON service account key.

-

Optional projectId

projectId?: string
+

Optional projectId

projectId?: string

Your Google Cloud project ID found in your JSON service account key.

-

Optional tokenUri

tokenUri?: string
+

Optional tokenUri

tokenUri?: string

Should be https://accounts.google.com/o/oauth2/token.

-

Optional type

type?: string
+

Optional type

type?: string

The value for service_account found in your JSON service account key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GCPIntegrationApi.html b/classes/v1.GCPIntegrationApi.html index d1e2c660862..f8f64856900 100644 --- a/classes/v1.GCPIntegrationApi.html +++ b/classes/v1.GCPIntegrationApi.html @@ -1,14 +1,14 @@ -GCPIntegrationApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GCPIntegrationApi

Hierarchy

  • GCPIntegrationApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GCPIntegrationApi(configuration: v1.Configuration, requestFactory?: GCPIntegrationApiRequestFactory, responseProcessor?: GCPIntegrationApiResponseProcessor): GCPIntegrationApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: GCPIntegrationApiRequestFactory

Private responseProcessor

responseProcessor: GCPIntegrationApiResponseProcessor

Methods

createGCPIntegration

deleteGCPIntegration

listGCPIntegration

Returns Promise<any>

listGCPIntegration

updateGCPIntegration

updateGCPIntegration

type

type: "geomap"

view

view: GeomapWidgetDefinitionView

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GeomapWidgetDefinitionStyle.html b/classes/v1.GeomapWidgetDefinitionStyle.html index 503f709cd1d..e9b8782d2f3 100644 --- a/classes/v1.GeomapWidgetDefinitionStyle.html +++ b/classes/v1.GeomapWidgetDefinitionStyle.html @@ -1,7 +1,7 @@ GeomapWidgetDefinitionStyle | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeomapWidgetDefinitionStyle

The style to apply to the widget.

-

Hierarchy

  • GeomapWidgetDefinitionStyle

Index

Constructors

Properties

Constructors

constructor

Properties

palette

palette: string
+

Hierarchy

  • GeomapWidgetDefinitionStyle

Index

Constructors

Properties

Constructors

constructor

Properties

palette

palette: string

The color palette to apply to the widget.

-

paletteFlip

paletteFlip: boolean
+

paletteFlip

paletteFlip: boolean

Whether to flip the palette tones.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GeomapWidgetDefinitionView.html b/classes/v1.GeomapWidgetDefinitionView.html index ba36022b93e..1be1edc7dfb 100644 --- a/classes/v1.GeomapWidgetDefinitionView.html +++ b/classes/v1.GeomapWidgetDefinitionView.html @@ -1,5 +1,5 @@ GeomapWidgetDefinitionView | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeomapWidgetDefinitionView

The view of the world that the map should render.

-

Hierarchy

  • GeomapWidgetDefinitionView

Index

Constructors

Properties

Constructors

constructor

Properties

focus

focus: string
+

Hierarchy

  • GeomapWidgetDefinitionView

Index

Constructors

Properties

Constructors

constructor

Properties

focus

focus: string

The 2-letter ISO code of a country to focus the map on. Or WORLD.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GeomapWidgetRequest.html b/classes/v1.GeomapWidgetRequest.html index c883f397b6e..e8718873bc3 100644 --- a/classes/v1.GeomapWidgetRequest.html +++ b/classes/v1.GeomapWidgetRequest.html @@ -1,9 +1,9 @@ GeomapWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeomapWidgetRequest

An updated geomap widget.

-

Hierarchy

  • GeomapWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional formulas

formulas?: WidgetFormula[]
+

Hierarchy

  • GeomapWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional q

q?: string

The widget metrics query.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GraphSnapshot.html b/classes/v1.GraphSnapshot.html index 4bb30be2a8b..ddf07fc2734 100644 --- a/classes/v1.GraphSnapshot.html +++ b/classes/v1.GraphSnapshot.html @@ -1,9 +1,9 @@ GraphSnapshot | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphSnapshot

Object representing a graph snapshot.

-

Hierarchy

  • GraphSnapshot

Index

Constructors

Properties

Constructors

constructor

Properties

Optional graphDef

graphDef?: string
+

Hierarchy

  • GraphSnapshot

Index

Constructors

Properties

Constructors

constructor

Properties

Optional graphDef

graphDef?: string

A JSON document defining the graph. graph_def can be used instead of metric_query. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded.

-

Optional metricQuery

metricQuery?: string
+

Optional metricQuery

metricQuery?: string

The metric query. One of metric_query or graph_def is required.

-

Optional snapshotUrl

snapshotUrl?: string
+

Optional snapshotUrl

snapshotUrl?: string

URL of your graph snapshot.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.GroupWidgetDefinition.html b/classes/v1.GroupWidgetDefinition.html index 11a630ea9a7..5db6dc24242 100644 --- a/classes/v1.GroupWidgetDefinition.html +++ b/classes/v1.GroupWidgetDefinition.html @@ -1,13 +1,13 @@ GroupWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupWidgetDefinition

The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.

-

Hierarchy

  • GroupWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string
+

Hierarchy

  • GroupWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string

Background color of the group title.

-

Optional bannerImg

bannerImg?: string
+

Optional bannerImg

bannerImg?: string

URL of image to display as a banner for the group.

-

layoutType

layoutType: "ordered"

Optional showTitle

showTitle?: boolean
+

layoutType

layoutType: "ordered"

Optional showTitle

showTitle?: boolean

Whether to show the title or not.

-

Optional title

title?: string
+

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

type

type: "group"

widgets

widgets: Widget[]
+

Optional titleAlign

titleAlign?: WidgetTextAlign

type

type: "group"

widgets

widgets: Widget[]

List of widget groups.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HTTPLogError.html b/classes/v1.HTTPLogError.html index 36db8d0bebc..4c1f625d9f6 100644 --- a/classes/v1.HTTPLogError.html +++ b/classes/v1.HTTPLogError.html @@ -1,7 +1,7 @@ HTTPLogError | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPLogError

Invalid query performed.

-

Hierarchy

  • HTTPLogError

Index

Constructors

Properties

Constructors

constructor

Properties

code

code: number
+

Hierarchy

  • HTTPLogError

Index

Constructors

Properties

Constructors

constructor

Properties

code

code: number

Error code.

-

message

message: string
+

message

message: string

Error message.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HTTPLogItem.html b/classes/v1.HTTPLogItem.html index b64603c9c3e..9b117531617 100644 --- a/classes/v1.HTTPLogItem.html +++ b/classes/v1.HTTPLogItem.html @@ -1,13 +1,13 @@ HTTPLogItem | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPLogItem

Logs that are sent over HTTP.

-

Hierarchy

  • HTTPLogItem

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ddsource

ddsource?: string
+

Hierarchy

  • HTTPLogItem

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ddsource

ddsource?: string

The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. See reserved attributes.

-

Optional ddtags

ddtags?: string
+

Optional ddtags

ddtags?: string

Tags associated with your logs.

-

Optional hostname

hostname?: string
+

Optional hostname

hostname?: string

The name of the originating host of the log.

-

message

message: string
+

message

message: string

The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.

-

Optional service

service?: string
+

Optional service

service?: string

The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. See reserved attributes.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HeatMapWidgetDefinition.html b/classes/v1.HeatMapWidgetDefinition.html index d4c5b8bab19..34def99be2c 100644 --- a/classes/v1.HeatMapWidgetDefinition.html +++ b/classes/v1.HeatMapWidgetDefinition.html @@ -1,17 +1,17 @@ HeatMapWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HeatMapWidgetDefinition

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

-

Hierarchy

  • HeatMapWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]
+

Hierarchy

  • HeatMapWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

-

Optional events

events?: WidgetEvent[]
+

Optional events

events?: WidgetEvent[]

List of widget events.

-

Optional legendSize

legendSize?: string
+

Optional legendSize

legendSize?: string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

-

requests

requests: HeatMapWidgetRequest[]
+

requests

requests: HeatMapWidgetRequest[]

List of widget types.

-

Optional showLegend

showLegend?: boolean
+

Optional showLegend

showLegend?: boolean

Whether or not to display the legend on this widget.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "heatmap"

Optional yaxis

yaxis?: WidgetAxis

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "heatmap"

Optional yaxis

yaxis?: WidgetAxis

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HeatMapWidgetRequest.html b/classes/v1.HeatMapWidgetRequest.html index 268932ae2ff..468afe25358 100644 --- a/classes/v1.HeatMapWidgetRequest.html +++ b/classes/v1.HeatMapWidgetRequest.html @@ -1,5 +1,5 @@ HeatMapWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HeatMapWidgetRequest

Updated heat map widget.

-

Hierarchy

  • HeatMapWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: EventQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Hierarchy

  • HeatMapWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: EventQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Widget query.

-

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Host.html b/classes/v1.Host.html index 9d30dc99d3f..fdfbbb8f5f7 100644 --- a/classes/v1.Host.html +++ b/classes/v1.Host.html @@ -1,27 +1,27 @@ Host | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Host

Object representing a host.

-

Hierarchy

  • Host

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aliases

aliases?: string[]
+

Hierarchy

  • Host

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aliases

aliases?: string[]

Host aliases collected by Datadog.

-

Optional apps

apps?: string[]
+

Optional apps

apps?: string[]

The Datadog integrations reporting metrics for the host.

-

Optional awsName

awsName?: string
+

Optional awsName

awsName?: string

AWS name of your host.

-

Optional hostName

hostName?: string
+

Optional hostName

hostName?: string

The host name.

-

Optional id

id?: number
+

Optional id

id?: number

The host ID.

-

Optional isMuted

isMuted?: boolean
+

Optional isMuted

isMuted?: boolean

If a host is muted or unmuted.

-

Optional lastReportedTime

lastReportedTime?: number
+

Optional lastReportedTime

lastReportedTime?: number

Last time the host reported a metric data point.

-

Optional meta

meta?: HostMeta

Optional metrics

metrics?: HostMetrics

Optional muteTimeout

muteTimeout?: number
+

Optional meta

meta?: HostMeta

Optional metrics

metrics?: HostMetrics

Optional muteTimeout

muteTimeout?: number

Timeout of the mute applied to your host.

-

Optional name

name?: string
+

Optional name

name?: string

The host name.

-

Optional sources

sources?: string[]
+

Optional sources

sources?: string[]

Source or cloud provider associated with your host.

-

Optional tagsBySource

tagsBySource?: {}
+

Optional tagsBySource

tagsBySource?: {}

List of tags for each source (AWS, Datadog Agent, Chef..).

-

Type declaration

  • [key: string]: string[]

Optional up

up?: boolean
+

Type declaration

  • [key: string]: string[]

Optional up

up?: boolean

Displays UP when the expected metrics are received and displays ??? if no metrics are received.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostListResponse.html b/classes/v1.HostListResponse.html index e07b167eb32..9873cc8327a 100644 --- a/classes/v1.HostListResponse.html +++ b/classes/v1.HostListResponse.html @@ -1,9 +1,9 @@ HostListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostListResponse

Response with Host information from Datadog.

-

Hierarchy

  • HostListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hostList

hostList?: Host[]
+

Hierarchy

  • HostListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hostList

hostList?: Host[]

Array of hosts.

-

Optional totalMatching

totalMatching?: number
+

Optional totalMatching

totalMatching?: number

Number of host matching the query.

-

Optional totalReturned

totalReturned?: number
+

Optional totalReturned

totalReturned?: number

Number of host returned.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMapRequest.html b/classes/v1.HostMapRequest.html index 0bbc62b81c5..d313e065d12 100644 --- a/classes/v1.HostMapRequest.html +++ b/classes/v1.HostMapRequest.html @@ -1,5 +1,5 @@ HostMapRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMapRequest

Updated host map.

-

Hierarchy

  • HostMapRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Hierarchy

  • HostMapRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Query definition.

-

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMapWidgetDefinition.html b/classes/v1.HostMapWidgetDefinition.html index a339239d269..638c018e7f7 100644 --- a/classes/v1.HostMapWidgetDefinition.html +++ b/classes/v1.HostMapWidgetDefinition.html @@ -1,19 +1,19 @@ HostMapWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMapWidgetDefinition

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

-

Hierarchy

  • HostMapWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]
+

Hierarchy

  • HostMapWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

-

Optional group

group?: string[]
+

Optional group

group?: string[]

List of tag prefixes to group by.

-

Optional noGroupHosts

noGroupHosts?: boolean
+

Optional noGroupHosts

noGroupHosts?: boolean

Whether to show the hosts that don’t fit in a group.

-

Optional noMetricHosts

noMetricHosts?: boolean
+

Optional noMetricHosts

noMetricHosts?: boolean

Whether to show the hosts with no metrics.

-

Optional nodeType

nodeType?: WidgetNodeType

Optional notes

notes?: string
+

Optional nodeType

nodeType?: WidgetNodeType

Optional notes

notes?: string

Notes on the title.

-

requests

requests: HostMapWidgetDefinitionRequests

Optional scope

scope?: string[]
+

requests

requests: HostMapWidgetDefinitionRequests

Optional scope

scope?: string[]

List of tags used to filter the map.

-

Optional style

style?: HostMapWidgetDefinitionStyle

Optional title

title?: string
+

Optional style

style?: HostMapWidgetDefinitionStyle

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "hostmap"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "hostmap"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMapWidgetDefinitionRequests.html b/classes/v1.HostMapWidgetDefinitionRequests.html index 7bb69bcafcd..c050cabd8ee 100644 --- a/classes/v1.HostMapWidgetDefinitionRequests.html +++ b/classes/v1.HostMapWidgetDefinitionRequests.html @@ -1,3 +1,3 @@ HostMapWidgetDefinitionRequests | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMapWidgetDefinitionRequests

List of definitions.

-

Hierarchy

  • HostMapWidgetDefinitionRequests

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fill

fill?: HostMapRequest

Optional size

size?: HostMapRequest

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • HostMapWidgetDefinitionRequests

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fill

fill?: HostMapRequest

Optional size

size?: HostMapRequest

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMapWidgetDefinitionStyle.html b/classes/v1.HostMapWidgetDefinitionStyle.html index 08a3a16b5bc..c8378bfbe73 100644 --- a/classes/v1.HostMapWidgetDefinitionStyle.html +++ b/classes/v1.HostMapWidgetDefinitionStyle.html @@ -1,11 +1,11 @@ HostMapWidgetDefinitionStyle | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMapWidgetDefinitionStyle

The style to apply to the widget.

-

Hierarchy

  • HostMapWidgetDefinitionStyle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fillMax

fillMax?: string
+

Hierarchy

  • HostMapWidgetDefinitionStyle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fillMax

fillMax?: string

Max value to use to color the map.

-

Optional fillMin

fillMin?: string
+

Optional fillMin

fillMin?: string

Min value to use to color the map.

-

Optional palette

palette?: string
+

Optional palette

palette?: string

Color palette to apply to the widget.

-

Optional paletteFlip

paletteFlip?: boolean
+

Optional paletteFlip

paletteFlip?: boolean

Whether to flip the palette tones.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMeta.html b/classes/v1.HostMeta.html index 0c58451d100..f6fe2a1b096 100644 --- a/classes/v1.HostMeta.html +++ b/classes/v1.HostMeta.html @@ -1,31 +1,31 @@ HostMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMeta

Metadata associated with your host.

-

Hierarchy

  • HostMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentChecks

agentChecks?: any[][]
+

Hierarchy

  • HostMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentChecks

agentChecks?: any[][]

A list of Agent checks running on the host.

-

Optional agentVersion

agentVersion?: string
+

Optional agentVersion

agentVersion?: string

The Datadog Agent version.

-

Optional cpuCores

cpuCores?: number
+

Optional cpuCores

cpuCores?: number

The number of cores.

-

Optional fbsdV

fbsdV?: string[]
+

Optional fbsdV

fbsdV?: string[]

An array of Mac versions.

-

Optional gohai

gohai?: string
+

Optional gohai

gohai?: string

JSON string containing system information.

-

Optional installMethod

installMethod?: HostMetaInstallMethod

Optional macV

macV?: string[]
+

Optional installMethod

installMethod?: HostMetaInstallMethod

Optional macV

macV?: string[]

An array of Mac versions.

-

Optional machine

machine?: string
+

Optional machine

machine?: string

The machine architecture.

-

Optional nixV

nixV?: string[]
+

Optional nixV

nixV?: string[]

Array of Unix versions.

-

Optional platform

platform?: string
+

Optional platform

platform?: string

The OS platform.

-

Optional processor

processor?: string
+

Optional processor

processor?: string

The processor.

-

Optional pythonV

pythonV?: string
+

Optional pythonV

pythonV?: string

The Python version.

-

Optional socketFqdn

socketFqdn?: string
+

Optional socketFqdn

socketFqdn?: string

The socket fqdn.

-

Optional socketHostname

socketHostname?: string
+

Optional socketHostname

socketHostname?: string

The socket hostname.

-

Optional winV

winV?: string[]
+

Optional winV

winV?: string[]

An array of Windows versions.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMetaInstallMethod.html b/classes/v1.HostMetaInstallMethod.html index 3553bbff01f..eac7713fdcd 100644 --- a/classes/v1.HostMetaInstallMethod.html +++ b/classes/v1.HostMetaInstallMethod.html @@ -1,9 +1,9 @@ HostMetaInstallMethod | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMetaInstallMethod

Agent install method.

-

Hierarchy

  • HostMetaInstallMethod

Index

Constructors

Properties

Constructors

constructor

Properties

Optional installerVersion

installerVersion?: string
+

Hierarchy

  • HostMetaInstallMethod

Index

Constructors

Properties

Constructors

constructor

Properties

Optional installerVersion

installerVersion?: string

The installer version.

-

Optional tool

tool?: string
+

Optional tool

tool?: string

Tool used to install the agent.

-

Optional toolVersion

toolVersion?: string
+

Optional toolVersion

toolVersion?: string

The tool version.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMetrics.html b/classes/v1.HostMetrics.html index 1492095ab7a..7ad211dd336 100644 --- a/classes/v1.HostMetrics.html +++ b/classes/v1.HostMetrics.html @@ -1,9 +1,9 @@ HostMetrics | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMetrics

Host Metrics collected.

-

Hierarchy

  • HostMetrics

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cpu

cpu?: number
+

Hierarchy

  • HostMetrics

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cpu

cpu?: number

The percent of CPU used (everything but idle).

-

Optional iowait

iowait?: number
+

Optional iowait

iowait?: number

The percent of CPU spent waiting on the IO (not reported for all platforms).

-

Optional load

load?: number
+

Optional load

load?: number

The system load over the last 15 minutes.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMuteResponse.html b/classes/v1.HostMuteResponse.html index 6e58deb2ac5..fbdf2bac054 100644 --- a/classes/v1.HostMuteResponse.html +++ b/classes/v1.HostMuteResponse.html @@ -1,11 +1,11 @@ HostMuteResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMuteResponse

Response with the list of muted host for your organization.

-

Hierarchy

  • HostMuteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional action

action?: string
+

Hierarchy

  • HostMuteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional action

action?: string

Action applied to the hosts.

-

Optional end

end?: number
+

Optional end

end?: number

POSIX timestamp in seconds when the host is unmuted.

-

Optional hostname

hostname?: string
+

Optional hostname

hostname?: string

The host name.

-

Optional message

message?: string
+

Optional message

message?: string

Message associated with the mute.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostMuteSettings.html b/classes/v1.HostMuteSettings.html index b5780f8ba57..a60dfe82f1a 100644 --- a/classes/v1.HostMuteSettings.html +++ b/classes/v1.HostMuteSettings.html @@ -1,9 +1,9 @@ HostMuteSettings | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostMuteSettings

Combination of settings to mute a host.

-

Hierarchy

  • HostMuteSettings

Index

Constructors

Properties

Constructors

constructor

Properties

Optional end

end?: number
+

Hierarchy

  • HostMuteSettings

Index

Constructors

Properties

Constructors

constructor

Properties

Optional end

end?: number

POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted.

-

Optional message

message?: string
+

Optional message

message?: string

Message to associate with the muting of this host.

-

Optional override

override?: boolean
+

Optional override

override?: boolean

If true and the host is already muted, replaces existing host mute settings.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostTags.html b/classes/v1.HostTags.html index ac5a95585ae..806d2ca5a0a 100644 --- a/classes/v1.HostTags.html +++ b/classes/v1.HostTags.html @@ -1,7 +1,7 @@ HostTags | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostTags

Set of tags to associate with your host.

-

Hierarchy

  • HostTags

Index

Constructors

Properties

Constructors

constructor

Properties

Optional host

host?: string
+

Hierarchy

  • HostTags

Index

Constructors

Properties

Constructors

constructor

Properties

Optional host

host?: string

Your host name.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

A list of tags to apply to the host.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostTotals.html b/classes/v1.HostTotals.html index 4b7e21b22aa..b2420589df3 100644 --- a/classes/v1.HostTotals.html +++ b/classes/v1.HostTotals.html @@ -1,7 +1,7 @@ HostTotals | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostTotals

Total number of host currently monitored by Datadog.

-

Hierarchy

  • HostTotals

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalActive

totalActive?: number
+

Hierarchy

  • HostTotals

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalActive

totalActive?: number

Total number of active host (UP and ???) reporting to Datadog.

-

Optional totalUp

totalUp?: number
+

Optional totalUp

totalUp?: number

Number of host that are UP and reporting to Datadog.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HostsApi.html b/classes/v1.HostsApi.html index 74e44f168f9..ad593f0842a 100644 --- a/classes/v1.HostsApi.html +++ b/classes/v1.HostsApi.html @@ -1,16 +1,16 @@ -HostsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HostsApi

Hierarchy

  • HostsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new HostsApi(configuration: v1.Configuration, requestFactory?: HostsApiRequestFactory, responseProcessor?: HostsApiResponseProcessor): HostsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: HostsApiRequestFactory

Private responseProcessor

responseProcessor: HostsApiResponseProcessor

Methods

getHostTotals

listHosts

muteHost

Returns Promise<HostListResponse>

muteHost

unmuteHost

Returns Promise<HostMuteResponse>

unmuteHost

Optional usageType

usageType?: HourlyUsageAttributionUsageType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HourlyUsageAttributionMetadata.html b/classes/v1.HourlyUsageAttributionMetadata.html index 6f9d60d0142..f1bfd03c4a1 100644 --- a/classes/v1.HourlyUsageAttributionMetadata.html +++ b/classes/v1.HourlyUsageAttributionMetadata.html @@ -1,3 +1,3 @@ HourlyUsageAttributionMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HourlyUsageAttributionMetadata

The object containing document metadata.

-

Hierarchy

  • HourlyUsageAttributionMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional pagination

pagination?: HourlyUsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • HourlyUsageAttributionMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional pagination

pagination?: HourlyUsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HourlyUsageAttributionPagination.html b/classes/v1.HourlyUsageAttributionPagination.html index a8fda00ceb4..52718730538 100644 --- a/classes/v1.HourlyUsageAttributionPagination.html +++ b/classes/v1.HourlyUsageAttributionPagination.html @@ -1,5 +1,5 @@ HourlyUsageAttributionPagination | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HourlyUsageAttributionPagination

The metadata for the current pagination.

-

Hierarchy

  • HourlyUsageAttributionPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional nextRecordId

nextRecordId?: string
+

Hierarchy

  • HourlyUsageAttributionPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional nextRecordId

nextRecordId?: string

The cursor to get the next results (if any). To make the next request, use the same parameters and add next_record_id.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HourlyUsageAttributionResponse.html b/classes/v1.HourlyUsageAttributionResponse.html index bc31930fe8f..fbf39b97a6d 100644 --- a/classes/v1.HourlyUsageAttributionResponse.html +++ b/classes/v1.HourlyUsageAttributionResponse.html @@ -1,5 +1,5 @@ HourlyUsageAttributionResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HourlyUsageAttributionResponse

Response containing the hourly usage attribution by tag(s).

-

Hierarchy

  • HourlyUsageAttributionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: HourlyUsageAttributionMetadata

Optional usage

usage?: HourlyUsageAttributionBody[]
+

Hierarchy

  • HourlyUsageAttributionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: HourlyUsageAttributionMetadata

Optional usage

usage?: HourlyUsageAttributionBody[]

Get the hourly usage attribution by tag(s).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.HttpException.html b/classes/v1.HttpException.html index 5b87bc64e77..22c494b3013 100644 --- a/classes/v1.HttpException.html +++ b/classes/v1.HttpException.html @@ -1,4 +1,4 @@ -HttpException | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpException

Hierarchy

  • Error
    • HttpException

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

deleteAPIKey

deleteApplicationKey

Returns Promise<ApiKeyResponse>

deleteApplicationKey

getAPIKey

Returns Promise<v1.ApplicationKeyResponse>

getAPIKey

getApplicationKey

Returns Promise<ApiKeyResponse>

getApplicationKey

listAPIKeys

Returns Promise<v1.ApplicationKeyResponse>

listAPIKeys

listApplicationKeys

listApplicationKeys

updateAPIKey

updateAPIKey

updateApplicationKey

Returns Promise<ApiKeyResponse>

updateApplicationKey

width

width: ListStreamColumnWidth

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ListStreamQuery.html b/classes/v1.ListStreamQuery.html index 54dc134d85f..80defe9fe39 100644 --- a/classes/v1.ListStreamQuery.html +++ b/classes/v1.ListStreamQuery.html @@ -1,7 +1,7 @@ ListStreamQuery | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListStreamQuery

Updated list stream widget.

-

Hierarchy

  • ListStreamQuery

Index

Constructors

Properties

Constructors

constructor

Properties

dataSource

dataSource: ListStreamSource

Optional indexes

indexes?: string[]
+

Hierarchy

  • ListStreamQuery

Index

Constructors

Properties

Constructors

constructor

Properties

dataSource

dataSource: ListStreamSource

Optional indexes

indexes?: string[]

List of indexes.

-

queryString

queryString: string
+

queryString

queryString: string

Widget query.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ListStreamWidgetDefinition.html b/classes/v1.ListStreamWidgetDefinition.html index 587e4fbcf28..12f7ba8bc3e 100644 --- a/classes/v1.ListStreamWidgetDefinition.html +++ b/classes/v1.ListStreamWidgetDefinition.html @@ -1,13 +1,13 @@ ListStreamWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListStreamWidgetDefinition

The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns.

-

Hierarchy

  • ListStreamWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional legendSize

legendSize?: string
+

Hierarchy

  • ListStreamWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional legendSize

legendSize?: string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

-

requests

requests: ListStreamWidgetRequest[]
+

requests

requests: ListStreamWidgetRequest[]

Request payload used to query items.

-

Optional showLegend

showLegend?: boolean
+

Optional showLegend

showLegend?: boolean

Whether or not to display the legend on this widget.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "list_stream"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "list_stream"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ListStreamWidgetRequest.html b/classes/v1.ListStreamWidgetRequest.html index c4be8bc136b..26f0e50513e 100644 --- a/classes/v1.ListStreamWidgetRequest.html +++ b/classes/v1.ListStreamWidgetRequest.html @@ -1,5 +1,5 @@ ListStreamWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListStreamWidgetRequest

Updated list stream widget.

-

Hierarchy

  • ListStreamWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

columns

columns: ListStreamColumn[]
+

Hierarchy

  • ListStreamWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

columns

columns: ListStreamColumn[]

Widget columns.

-

query

query: ListStreamQuery

responseFormat

responseFormat: "event_list"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

query

query: ListStreamQuery

responseFormat

responseFormat: "event_list"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Log.html b/classes/v1.Log.html index 08eec71ec99..f305ea654ea 100644 --- a/classes/v1.Log.html +++ b/classes/v1.Log.html @@ -1,5 +1,5 @@ Log | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Log

Object describing a log after being processed and stored by Datadog.

-

Hierarchy

  • Log

Index

Constructors

Properties

Constructors

constructor

Properties

Optional content

content?: LogContent

Optional id

id?: string
+

Hierarchy

  • Log

Index

Constructors

Properties

Constructors

constructor

Properties

Optional content

content?: LogContent

Optional id

id?: string

Unique ID of the Log.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogContent.html b/classes/v1.LogContent.html index 447d61c623b..8ac78800f0a 100644 --- a/classes/v1.LogContent.html +++ b/classes/v1.LogContent.html @@ -1,15 +1,15 @@ LogContent | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogContent

JSON object containing all log attributes and their associated values.

-

Hierarchy

  • LogContent

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: {}
+

Hierarchy

  • LogContent

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: {}

JSON object of attributes from your log.

-

Type declaration

  • [key: string]: any

Optional host

host?: string
+

Type declaration

  • [key: string]: any

Optional host

host?: string

Name of the machine from where the logs are being sent.

-

Optional message

message?: string
+

Optional message

message?: string

The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.

-

Optional service

service?: string
+

Optional service

service?: string

The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products.

-

Optional tags

tags?: any[]
+

Optional tags

tags?: any[]

Array of tags associated with your log.

-

Optional timestamp

timestamp?: Date
+

Optional timestamp

timestamp?: Date

Timestamp of your log.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogQueryDefinition.html b/classes/v1.LogQueryDefinition.html index 9c03f037b13..9e824604413 100644 --- a/classes/v1.LogQueryDefinition.html +++ b/classes/v1.LogQueryDefinition.html @@ -1,9 +1,9 @@ LogQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogQueryDefinition

The log query.

-

Hierarchy

  • LogQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional compute

compute?: LogsQueryCompute

Optional groupBy

groupBy?: LogQueryDefinitionGroupBy[]
+

Hierarchy

  • LogQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional compute

compute?: LogsQueryCompute

Optional groupBy

groupBy?: LogQueryDefinitionGroupBy[]

List of tag prefixes to group by in the case of a cluster check.

-

Optional index

index?: string
+

Optional index

index?: string

A coma separated-list of index names. Use "*" query all indexes at once. Multiple Indexes

-

Optional multiCompute

multiCompute?: LogsQueryCompute[]
+

Optional multiCompute

multiCompute?: LogsQueryCompute[]

This field is mutually exclusive with compute.

-

Optional search

search?: LogQueryDefinitionSearch

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional search

search?: LogQueryDefinitionSearch

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogQueryDefinitionGroupBy.html b/classes/v1.LogQueryDefinitionGroupBy.html index 9491f47e469..3abf2d03b70 100644 --- a/classes/v1.LogQueryDefinitionGroupBy.html +++ b/classes/v1.LogQueryDefinitionGroupBy.html @@ -1,7 +1,7 @@ LogQueryDefinitionGroupBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogQueryDefinitionGroupBy

Defined items in the group.

-

Hierarchy

  • LogQueryDefinitionGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string
+

Hierarchy

  • LogQueryDefinitionGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string

Facet name.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Maximum number of items in the group.

-

Optional sort

sort?: LogQueryDefinitionGroupBySort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional sort

sort?: LogQueryDefinitionGroupBySort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogQueryDefinitionGroupBySort.html b/classes/v1.LogQueryDefinitionGroupBySort.html index f9fd5b9bbfe..3f123c89665 100644 --- a/classes/v1.LogQueryDefinitionGroupBySort.html +++ b/classes/v1.LogQueryDefinitionGroupBySort.html @@ -1,7 +1,7 @@ LogQueryDefinitionGroupBySort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogQueryDefinitionGroupBySort

Define a sorting method.

-

Hierarchy

  • LogQueryDefinitionGroupBySort

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: string
+

Hierarchy

  • LogQueryDefinitionGroupBySort

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: string

The aggregation method.

-

Optional facet

facet?: string
+

Optional facet

facet?: string

Facet name.

-

order

order: WidgetSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

order

order: WidgetSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogQueryDefinitionSearch.html b/classes/v1.LogQueryDefinitionSearch.html index bd3eeee73ae..42def3686a4 100644 --- a/classes/v1.LogQueryDefinitionSearch.html +++ b/classes/v1.LogQueryDefinitionSearch.html @@ -1,5 +1,5 @@ LogQueryDefinitionSearch | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogQueryDefinitionSearch

The query being made on the logs.

-

Hierarchy

  • LogQueryDefinitionSearch

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string
+

Hierarchy

  • LogQueryDefinitionSearch

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string

Search value to apply.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogStreamWidgetDefinition.html b/classes/v1.LogStreamWidgetDefinition.html index 0f78f422a5f..1e6bfbf7c08 100644 --- a/classes/v1.LogStreamWidgetDefinition.html +++ b/classes/v1.LogStreamWidgetDefinition.html @@ -1,19 +1,19 @@ LogStreamWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogStreamWidgetDefinition

The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.

-

Hierarchy

  • LogStreamWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional columns

columns?: string[]
+

Hierarchy

  • LogStreamWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional columns

columns?: string[]

Which columns to display on the widget.

-

Optional indexes

indexes?: string[]
+

Optional indexes

indexes?: string[]

An array of index names to query in the stream. Use [] to query all indexes at once.

-

Optional logset

logset?: string
+

Optional logset

logset?: string

ID of the log set to use.

-

Optional messageDisplay

messageDisplay?: WidgetMessageDisplay

Optional query

query?: string
+

Optional messageDisplay

messageDisplay?: WidgetMessageDisplay

Optional query

query?: string

Query to filter the log stream with.

-

Optional showDateColumn

showDateColumn?: boolean
+

Optional showDateColumn

showDateColumn?: boolean

Whether to show the date column or not

-

Optional showMessageColumn

showMessageColumn?: boolean
+

Optional showMessageColumn

showMessageColumn?: boolean

Whether to show the message column or not

-

Optional sort

sort?: WidgetFieldSort

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional sort

sort?: WidgetFieldSort

Optional time

time?: WidgetTime

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "log_stream"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "log_stream"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsAPIError.html b/classes/v1.LogsAPIError.html index 70e376bfbc2..376113008c3 100644 --- a/classes/v1.LogsAPIError.html +++ b/classes/v1.LogsAPIError.html @@ -1,9 +1,9 @@ LogsAPIError | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAPIError

Error returned by the Logs API

-

Hierarchy

  • LogsAPIError

Index

Constructors

Properties

Constructors

constructor

Properties

Optional code

code?: string
+

Hierarchy

  • LogsAPIError

Index

Constructors

Properties

Constructors

constructor

Properties

Optional code

code?: string

Code identifying the error

-

Optional details

details?: LogsAPIError[]
+

Optional details

details?: LogsAPIError[]

Additional error details

-

Optional message

message?: string
+

Optional message

message?: string

Error message

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsAPIErrorResponse.html b/classes/v1.LogsAPIErrorResponse.html index 6cdc8d0b20c..d6ffd00e5d8 100644 --- a/classes/v1.LogsAPIErrorResponse.html +++ b/classes/v1.LogsAPIErrorResponse.html @@ -1,3 +1,3 @@ LogsAPIErrorResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAPIErrorResponse

Response returned by the Logs API when errors occur.

-

Hierarchy

  • LogsAPIErrorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional error

error?: LogsAPIError

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsAPIErrorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional error

error?: LogsAPIError

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsApi.html b/classes/v1.LogsApi.html index 5e3d3d8f195..d6c7e22a996 100644 --- a/classes/v1.LogsApi.html +++ b/classes/v1.LogsApi.html @@ -1,8 +1,8 @@ -LogsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsApi

Hierarchy

  • LogsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogsApi(configuration: v1.Configuration, requestFactory?: LogsApiRequestFactory, responseProcessor?: LogsApiResponseProcessor): v1.LogsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: LogsApiRequestFactory

Private responseProcessor

responseProcessor: LogsApiResponseProcessor

Methods

listLogs

submitLog

type

type: "arithmetic-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsAttributeRemapper.html b/classes/v1.LogsAttributeRemapper.html index 6403e1c07da..4789fde5bd0 100644 --- a/classes/v1.LogsAttributeRemapper.html +++ b/classes/v1.LogsAttributeRemapper.html @@ -1,19 +1,19 @@ LogsAttributeRemapper | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAttributeRemapper

The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. Constraints on the tag/attribute name are explained in the Tag Best Practice documentation. Some additional constraints are applied as : or , are not allowed in the target tag/attribute name.

-

Hierarchy

  • LogsAttributeRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsAttributeRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

Optional overrideOnConflict

overrideOnConflict?: boolean
+

Optional overrideOnConflict

overrideOnConflict?: boolean

Override or not the target element if already set,

-

Optional preserveSource

preserveSource?: boolean
+

Optional preserveSource

preserveSource?: boolean

Remove or preserve the remapped source element.

-

Optional sourceType

sourceType?: string
+

Optional sourceType

sourceType?: string

Defines if the sources are from log attribute or tag.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

target

target: string
+

target

target: string

Final attribute or tag name to remap the sources to.

-

Optional targetFormat

targetFormat?: TargetFormatType

Optional targetType

targetType?: string
+

Optional targetFormat

targetFormat?: TargetFormatType

Optional targetType

targetType?: string

Defines if the final attribute or tag name is from log attribute or tag.

-

type

type: "attribute-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "attribute-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetention.html b/classes/v1.LogsByRetention.html index ceb6589bce5..66267715ac9 100644 --- a/classes/v1.LogsByRetention.html +++ b/classes/v1.LogsByRetention.html @@ -1,5 +1,5 @@ LogsByRetention | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsByRetention

Object containing logs usage data broken down by retention period.

-

Hierarchy

  • LogsByRetention

Index

Constructors

Properties

Constructors

constructor

Properties

Optional orgs

orgs?: LogsByRetentionOrgs

Optional usage

usage?: LogsRetentionAggSumUsage[]
+

Hierarchy

  • LogsByRetention

Index

Constructors

Properties

Constructors

constructor

Properties

Optional orgs

orgs?: LogsByRetentionOrgs

Optional usage

usage?: LogsRetentionAggSumUsage[]

Aggregated index logs usage for each retention period with usage.

-

Optional usageByMonth

usageByMonth?: LogsByRetentionMonthlyUsage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional usageByMonth

usageByMonth?: LogsByRetentionMonthlyUsage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetentionMonthlyUsage.html b/classes/v1.LogsByRetentionMonthlyUsage.html index 3b3a4ac7024..1d5cc3392ab 100644 --- a/classes/v1.LogsByRetentionMonthlyUsage.html +++ b/classes/v1.LogsByRetentionMonthlyUsage.html @@ -1,7 +1,7 @@ LogsByRetentionMonthlyUsage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsByRetentionMonthlyUsage

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

-

Hierarchy

  • LogsByRetentionMonthlyUsage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional date

date?: string
+

Hierarchy

  • LogsByRetentionMonthlyUsage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional date

date?: string

The month for the usage.

-

Optional usage

usage?: LogsRetentionSumUsage[]
+

Optional usage

usage?: LogsRetentionSumUsage[]

Indexed logs usage for each active retention for the month.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetentionOrgUsage.html b/classes/v1.LogsByRetentionOrgUsage.html index aeac54c02f7..13152f5599c 100644 --- a/classes/v1.LogsByRetentionOrgUsage.html +++ b/classes/v1.LogsByRetentionOrgUsage.html @@ -1,5 +1,5 @@ LogsByRetentionOrgUsage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsByRetentionOrgUsage

Indexed logs usage by retention for a single organization.

-

Hierarchy

  • LogsByRetentionOrgUsage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: LogsRetentionSumUsage[]
+

Hierarchy

  • LogsByRetentionOrgUsage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: LogsRetentionSumUsage[]

Indexed logs usage for each active retention for the organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetentionOrgs.html b/classes/v1.LogsByRetentionOrgs.html index 2d484bffbca..b2741a7b9e4 100644 --- a/classes/v1.LogsByRetentionOrgs.html +++ b/classes/v1.LogsByRetentionOrgs.html @@ -1,5 +1,5 @@ LogsByRetentionOrgs | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsByRetentionOrgs

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

-

Hierarchy

  • LogsByRetentionOrgs

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: LogsByRetentionOrgUsage[]
+

Hierarchy

  • LogsByRetentionOrgs

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: LogsByRetentionOrgUsage[]

Indexed logs usage summary for each organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsCategoryProcessor.html b/classes/v1.LogsCategoryProcessor.html index 3877f25714c..1c7d6b42b44 100644 --- a/classes/v1.LogsCategoryProcessor.html +++ b/classes/v1.LogsCategoryProcessor.html @@ -1,11 +1,11 @@ LogsCategoryProcessor | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsCategoryProcessor

Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper.

-

Hierarchy

  • LogsCategoryProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

categories

categories: LogsCategoryProcessorCategory[]
+

Hierarchy

  • LogsCategoryProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

categories

categories: LogsCategoryProcessorCategory[]

Array of filters to match or not a log and their corresponding nameto assign a custom value to the log.

-

Optional isEnabled

isEnabled?: boolean
+

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

target

target: string
+

target

target: string

Name of the target attribute which value is defined by the matching category.

-

type

type: "category-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "category-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsCategoryProcessorCategory.html b/classes/v1.LogsCategoryProcessorCategory.html index c64393158c5..2fce837b1f0 100644 --- a/classes/v1.LogsCategoryProcessorCategory.html +++ b/classes/v1.LogsCategoryProcessorCategory.html @@ -1,5 +1,5 @@ LogsCategoryProcessorCategory | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsCategoryProcessorCategory

Object describing the logs filter.

-

Hierarchy

  • LogsCategoryProcessorCategory

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsFilter

Optional name

name?: string
+

Hierarchy

  • LogsCategoryProcessorCategory

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsFilter

Optional name

name?: string

Value to assign to the target attribute.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsDateRemapper.html b/classes/v1.LogsDateRemapper.html index 689723c7380..5144e98105b 100644 --- a/classes/v1.LogsDateRemapper.html +++ b/classes/v1.LogsDateRemapper.html @@ -1,9 +1,9 @@ LogsDateRemapper | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsDateRemapper

As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. - timestamp - date - _timestamp - Timestamp - eventTime - published_date If your logs put their dates in an attribute not in this list, use the log date Remapper Processor to define their date attribute as the official log timestamp. The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. Note: If your logs don’t contain any of the default attributes and you haven’t defined your own date attribute, Datadog timestamps the logs with the date it received them. If multiple log date remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.

-

Hierarchy

  • LogsDateRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsDateRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

type

type: "date-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "date-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsExclusion.html b/classes/v1.LogsExclusion.html index d0a5cdc7d8c..9b6c31b80cc 100644 --- a/classes/v1.LogsExclusion.html +++ b/classes/v1.LogsExclusion.html @@ -1,7 +1,7 @@ LogsExclusion | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsExclusion

Represents the index exclusion filter object from configuration API.

-

Hierarchy

  • LogsExclusion

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsExclusionFilter

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsExclusion

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsExclusionFilter

Optional isEnabled

isEnabled?: boolean

Whether or not the exclusion filter is active.

-

name

name: string
+

name

name: string

Name of the index exclusion filter.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsExclusionFilter.html b/classes/v1.LogsExclusionFilter.html index 12c7bd7c5b9..0e2b7c93739 100644 --- a/classes/v1.LogsExclusionFilter.html +++ b/classes/v1.LogsExclusionFilter.html @@ -1,7 +1,7 @@ LogsExclusionFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsExclusionFilter

Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle.

-

Hierarchy

  • LogsExclusionFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string
+

Hierarchy

  • LogsExclusionFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string

Default query is *, meaning all logs flowing in the index would be excluded. Scope down exclusion filter to only a subset of logs with a log query.

-

sampleRate

sampleRate: number
+

sampleRate

sampleRate: number

Sample rate to apply to logs going through this exclusion filter, a value of 1.0 excludes all logs matching the query.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsFilter.html b/classes/v1.LogsFilter.html index 4d5036c31ff..023ebb99c28 100644 --- a/classes/v1.LogsFilter.html +++ b/classes/v1.LogsFilter.html @@ -1,5 +1,5 @@ LogsFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsFilter

Filter for logs.

-

Hierarchy

  • LogsFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string
+

Hierarchy

  • LogsFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string

The filter query.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsGeoIPParser.html b/classes/v1.LogsGeoIPParser.html index 26ec16ee29c..b10a1168b90 100644 --- a/classes/v1.LogsGeoIPParser.html +++ b/classes/v1.LogsGeoIPParser.html @@ -1,11 +1,11 @@ LogsGeoIPParser | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsGeoIPParser

The GeoIP parser takes an IP address attribute and extracts if available the Continent, Country, Subdivision, and City information in the target attribute path.

-

Hierarchy

  • LogsGeoIPParser

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsGeoIPParser

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

target

target: string
+

target

target: string

Name of the parent attribute that contains all the extracted details from the sources.

-

type

type: "geo-ip-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "geo-ip-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsGrokParser.html b/classes/v1.LogsGrokParser.html index e1984ddd69a..84a4a7b6c2b 100644 --- a/classes/v1.LogsGrokParser.html +++ b/classes/v1.LogsGrokParser.html @@ -1,11 +1,11 @@ LogsGrokParser | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsGrokParser

Create custom grok rules to parse the full message or a specific attribute of your raw event. For more information, see the parsing section.

-

Hierarchy

  • LogsGrokParser

Index

Constructors

Properties

Constructors

constructor

Properties

grok

grok: LogsGrokParserRules

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsGrokParser

Index

Constructors

Properties

Constructors

constructor

Properties

grok

grok: LogsGrokParserRules

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

Optional samples

samples?: string[]
+

Optional samples

samples?: string[]

List of sample logs to test this grok parser.

-

source

source: string
+

source

source: string

Name of the log attribute to parse.

-

type

type: "grok-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "grok-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsGrokParserRules.html b/classes/v1.LogsGrokParserRules.html index 1cd9c8da225..927ff313e63 100644 --- a/classes/v1.LogsGrokParserRules.html +++ b/classes/v1.LogsGrokParserRules.html @@ -1,7 +1,7 @@ LogsGrokParserRules | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsGrokParserRules

Set of rules for the grok parser.

-

Hierarchy

  • LogsGrokParserRules

Index

Constructors

Properties

Constructors

constructor

Properties

matchRules

matchRules: string
+

Hierarchy

  • LogsGrokParserRules

Index

Constructors

Properties

Constructors

constructor

Properties

matchRules

matchRules: string

List of match rules for the grok parser, separated by a new line.

-

Optional supportRules

supportRules?: string
+

Optional supportRules

supportRules?: string

List of support rules for the grok parser, separated by a new line.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsIndex.html b/classes/v1.LogsIndex.html index a99823fe00d..3f2c7f2e9e7 100644 --- a/classes/v1.LogsIndex.html +++ b/classes/v1.LogsIndex.html @@ -1,13 +1,13 @@ LogsIndex | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsIndex

Object describing a Datadog Log index.

-

Hierarchy

  • LogsIndex

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dailyLimit

dailyLimit?: number
+

Hierarchy

  • LogsIndex

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dailyLimit

dailyLimit?: number

The number of log events you can send in this index per day before you are rate-limited.

-

Optional exclusionFilters

exclusionFilters?: LogsExclusion[]
+

Optional exclusionFilters

exclusionFilters?: LogsExclusion[]

An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored.

-

filter

filter: LogsFilter

Optional isRateLimited

isRateLimited?: boolean
+

filter

filter: LogsFilter

Optional isRateLimited

isRateLimited?: boolean

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC.

-

name

name: string
+

name

name: string

The name of the index.

-

Optional numRetentionDays

numRetentionDays?: number
+

Optional numRetentionDays

numRetentionDays?: number

The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsIndexListResponse.html b/classes/v1.LogsIndexListResponse.html index 7b80431186d..889e94e71e0 100644 --- a/classes/v1.LogsIndexListResponse.html +++ b/classes/v1.LogsIndexListResponse.html @@ -1,5 +1,5 @@ LogsIndexListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsIndexListResponse

Object with all Index configurations for a given organization.

-

Hierarchy

  • LogsIndexListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional indexes

indexes?: LogsIndex[]
+

Hierarchy

  • LogsIndexListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional indexes

indexes?: LogsIndex[]

Array of Log index configurations.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsIndexUpdateRequest.html b/classes/v1.LogsIndexUpdateRequest.html index c6abe498bf8..a64719afc5c 100644 --- a/classes/v1.LogsIndexUpdateRequest.html +++ b/classes/v1.LogsIndexUpdateRequest.html @@ -1,11 +1,11 @@ LogsIndexUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsIndexUpdateRequest

Object for updating a Datadog Log index.

-

Hierarchy

  • LogsIndexUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dailyLimit

dailyLimit?: number
+

Hierarchy

  • LogsIndexUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dailyLimit

dailyLimit?: number

The number of log events you can send in this index per day before you are rate-limited.

-

Optional disableDailyLimit

disableDailyLimit?: boolean
+

Optional disableDailyLimit

disableDailyLimit?: boolean

If true, sets the daily_limit value to null and the index is not limited on a daily basis (any specified daily_limit value in the request is ignored). If false or omitted, the index's current daily_limit is maintained.

-

Optional exclusionFilters

exclusionFilters?: LogsExclusion[]
+

Optional exclusionFilters

exclusionFilters?: LogsExclusion[]

An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored.

-

filter

filter: LogsFilter

Optional numRetentionDays

numRetentionDays?: number
+

filter

filter: LogsFilter

Optional numRetentionDays

numRetentionDays?: number

The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. Note: Changing the retention for an index adjusts the length of retention for all logs already in this index. It may also affect billing.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsIndexesApi.html b/classes/v1.LogsIndexesApi.html index a77e004f42b..942affba9be 100644 --- a/classes/v1.LogsIndexesApi.html +++ b/classes/v1.LogsIndexesApi.html @@ -1,20 +1,20 @@ -LogsIndexesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsIndexesApi

Hierarchy

  • LogsIndexesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogsIndexesApi(configuration: v1.Configuration, requestFactory?: LogsIndexesApiRequestFactory, responseProcessor?: LogsIndexesApiResponseProcessor): LogsIndexesApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: LogsIndexesApiRequestFactory

Private responseProcessor

responseProcessor: LogsIndexesApiResponseProcessor

Methods

createLogsIndex

getLogsIndex

getLogsIndexOrder

Returns Promise<LogsIndex>

getLogsIndexOrder

listLogIndexes

listLogIndexes

updateLogsIndex

updateLogsIndex

updateLogsIndexOrder

Returns Promise<LogsIndex>

updateLogsIndexOrder

time

time: LogsListRequestTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsListRequestTime.html b/classes/v1.LogsListRequestTime.html index ebaa5101681..ae10c409eed 100644 --- a/classes/v1.LogsListRequestTime.html +++ b/classes/v1.LogsListRequestTime.html @@ -1,9 +1,9 @@ LogsListRequestTime | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsListRequestTime

Timeframe to retrieve the log from.

-

Hierarchy

  • LogsListRequestTime

Index

Constructors

Properties

Constructors

constructor

Properties

from

from: Date
+

Hierarchy

  • LogsListRequestTime

Index

Constructors

Properties

Constructors

constructor

Properties

from

from: Date

Minimum timestamp for requested logs.

-

Optional timezone

timezone?: string
+

Optional timezone

timezone?: string

Timezone can be specified both as an offset (for example "UTC+03:00") or a regional zone (for example "Europe/Paris").

-

to

to: Date
+

to

to: Date

Maximum timestamp for requested logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsListResponse.html b/classes/v1.LogsListResponse.html index 05edb22d6ca..006c507d13a 100644 --- a/classes/v1.LogsListResponse.html +++ b/classes/v1.LogsListResponse.html @@ -1,9 +1,9 @@ LogsListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsListResponse

Response object with all logs matching the request and pagination information.

-

Hierarchy

  • LogsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional logs

logs?: v1.Log[]
+

Hierarchy

  • LogsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional logs

logs?: v1.Log[]

Array of logs matching the request and the nextLogId if sent.

-

Optional nextLogId

nextLogId?: string
+

Optional nextLogId

nextLogId?: string

Hash identifier of the next log to return in the list. This parameter is used for the pagination feature.

-

Optional status

status?: string
+

Optional status

status?: string

Status of the response.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsLookupProcessor.html b/classes/v1.LogsLookupProcessor.html index 97219116cae..ac4033345af 100644 --- a/classes/v1.LogsLookupProcessor.html +++ b/classes/v1.LogsLookupProcessor.html @@ -1,15 +1,15 @@ LogsLookupProcessor | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsLookupProcessor

Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. For example, you can use the Lookup Processor to map an internal service ID into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines.

-

Hierarchy

  • LogsLookupProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional defaultLookup

defaultLookup?: string
+

Hierarchy

  • LogsLookupProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional defaultLookup

defaultLookup?: string

Value to set the target attribute if the source value is not found in the list.

-

Optional isEnabled

isEnabled?: boolean
+

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

lookupTable

lookupTable: string[]
+

lookupTable

lookupTable: string[]

Mapping table of values for the source attribute and their associated target attribute values, formatted as [\"source_key1,target_value1\", \"source_key2,target_value2\"]

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

source

source: string
+

source

source: string

Source attribute used to perform the lookup.

-

target

target: string
+

target

target: string

Name of the attribute that contains the corresponding value in the mapping list or the default_lookup if not found in the mapping list.

-

type

type: "lookup-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "lookup-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsMessageRemapper.html b/classes/v1.LogsMessageRemapper.html index ddcbbc2660f..f22e3d5e7c3 100644 --- a/classes/v1.LogsMessageRemapper.html +++ b/classes/v1.LogsMessageRemapper.html @@ -1,9 +1,9 @@ LogsMessageRemapper | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMessageRemapper

The message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. Note: If multiple log message remapper processors can be applied to a given log, only the first one (according to the pipeline order) is taken into account.

-

Hierarchy

  • LogsMessageRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsMessageRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

type

type: "message-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "message-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsPipeline.html b/classes/v1.LogsPipeline.html index a0921e94eb4..26060c7850a 100644 --- a/classes/v1.LogsPipeline.html +++ b/classes/v1.LogsPipeline.html @@ -1,15 +1,15 @@ LogsPipeline | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsPipeline

Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. Note: These endpoints are only available for admin users. Make sure to use an application key created by an admin.

-

Hierarchy

  • LogsPipeline

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsFilter

Optional id

id?: string
+

Hierarchy

  • LogsPipeline

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsFilter

Optional id

id?: string

ID of the pipeline.

-

Optional isEnabled

isEnabled?: boolean
+

Optional isEnabled

isEnabled?: boolean

Whether or not the pipeline is enabled.

-

Optional isReadOnly

isReadOnly?: boolean
+

Optional isReadOnly

isReadOnly?: boolean

Whether or not the pipeline can be edited.

-

name

name: string
+

name

name: string

Name of the pipeline.

-

Optional processors

processors?: LogsProcessor[]
+

Optional processors

processors?: LogsProcessor[]

Ordered list of processors in this pipeline.

-

Optional type

type?: string
+

Optional type

type?: string

Type of pipeline.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsPipelineProcessor.html b/classes/v1.LogsPipelineProcessor.html index de7bd0dba48..58fa70b2338 100644 --- a/classes/v1.LogsPipelineProcessor.html +++ b/classes/v1.LogsPipelineProcessor.html @@ -1,9 +1,9 @@ LogsPipelineProcessor | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsPipelineProcessor

Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors.

-

Hierarchy

  • LogsPipelineProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsFilter

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsPipelineProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsFilter

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

Optional processors

processors?: LogsProcessor[]
+

Optional processors

processors?: LogsProcessor[]

Ordered list of processors in this pipeline.

-

type

type: "pipeline"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "pipeline"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsPipelinesApi.html b/classes/v1.LogsPipelinesApi.html index c617ea04380..bd581ef2a88 100644 --- a/classes/v1.LogsPipelinesApi.html +++ b/classes/v1.LogsPipelinesApi.html @@ -1,24 +1,24 @@ -LogsPipelinesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsPipelinesApi

Hierarchy

  • LogsPipelinesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogsPipelinesApi(configuration: v1.Configuration, requestFactory?: LogsPipelinesApiRequestFactory, responseProcessor?: LogsPipelinesApiResponseProcessor): LogsPipelinesApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: LogsPipelinesApiRequestFactory

Private responseProcessor

responseProcessor: LogsPipelinesApiResponseProcessor

Methods

createLogsPipeline

deleteLogsPipeline

getLogsPipeline

Returns Promise<void>

getLogsPipeline

getLogsPipelineOrder

Returns Promise<LogsPipeline>

getLogsPipelineOrder

listLogsPipelines

listLogsPipelines

updateLogsPipeline

updateLogsPipeline

updateLogsPipelineOrder

Returns Promise<LogsPipeline>

updateLogsPipelineOrder

type

type: "service-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsStatusRemapper.html b/classes/v1.LogsStatusRemapper.html index a803f833ee3..9ba220c236e 100644 --- a/classes/v1.LogsStatusRemapper.html +++ b/classes/v1.LogsStatusRemapper.html @@ -1,9 +1,9 @@ LogsStatusRemapper | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsStatusRemapper

Use this Processor if you want to assign some attributes as the official status. Each incoming status value is mapped as follows. - Integers from 0 to 7 map to the Syslog severity standards - Strings beginning with emerg or f (case-insensitive) map to emerg (0) - Strings beginning with a (case-insensitive) map to alert (1) - Strings beginning with c (case-insensitive) map to critical (2) - Strings beginning with err (case-insensitive) map to error (3) - Strings beginning with w (case-insensitive) map to warning (4) - Strings beginning with n (case-insensitive) map to notice (5) - Strings beginning with i (case-insensitive) map to info (6) - Strings beginning with d, trace or verbose (case-insensitive) map to debug (7) - Strings beginning with o or matching OK or Success (case-insensitive) map to OK - All others map to info (6) Note: If multiple log status remapper processors can be applied to a given log, only the first one (according to the pipelines order) is taken into account.

-

Hierarchy

  • LogsStatusRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsStatusRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

type

type: "status-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "status-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsStringBuilderProcessor.html b/classes/v1.LogsStringBuilderProcessor.html index 526c789827b..1a147a5a23a 100644 --- a/classes/v1.LogsStringBuilderProcessor.html +++ b/classes/v1.LogsStringBuilderProcessor.html @@ -1,13 +1,13 @@ LogsStringBuilderProcessor | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsStringBuilderProcessor

Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute. The template is defined by both raw text and blocks with the syntax %{attribute_path}. Notes: - The processor only accepts attributes with values or an array of values in the blocks. - If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection. - If the target attribute already exists, it is overwritten by the result of the template. - Results of the template cannot exceed 256 characters.

-

Hierarchy

  • LogsStringBuilderProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsStringBuilderProcessor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional isReplaceMissing

isReplaceMissing?: boolean
+

Optional isReplaceMissing

isReplaceMissing?: boolean

If true, it replaces all missing attributes of template by an empty string. If false (default), skips the operation for missing attributes.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

target

target: string
+

target

target: string

The name of the attribute that contains the result of the template.

-

template

template: string
+

template

template: string

A formula with one or more attributes and raw text.

-

type

type: "string-builder-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "string-builder-processor"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsTraceRemapper.html b/classes/v1.LogsTraceRemapper.html index 8e40087d97c..523d8bcb1cc 100644 --- a/classes/v1.LogsTraceRemapper.html +++ b/classes/v1.LogsTraceRemapper.html @@ -1,9 +1,9 @@ LogsTraceRemapper | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsTraceRemapper

There are two ways to improve correlation between application traces and logs. 1. Follow the documentation on how to inject a trace ID in the application logs and by default log integrations take care of all the rest of the setup. 2. Use the Trace remapper processor to define a log attribute as its associated trace ID.

-

Hierarchy

  • LogsTraceRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsTraceRemapper

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

Optional sources

sources?: string[]
+

Optional sources

sources?: string[]

Array of source attributes.

-

type

type: "trace-id-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "trace-id-remapper"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsURLParser.html b/classes/v1.LogsURLParser.html index 898db154a1d..fc6d39d4b99 100644 --- a/classes/v1.LogsURLParser.html +++ b/classes/v1.LogsURLParser.html @@ -1,13 +1,13 @@ LogsURLParser | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsURLParser

This processor extracts query parameters and other important parameters from a URL.

-

Hierarchy

  • LogsURLParser

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsURLParser

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

Optional normalizeEndingSlashes

normalizeEndingSlashes?: boolean
+

Optional normalizeEndingSlashes

normalizeEndingSlashes?: boolean

Normalize the ending slashes or not.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

target

target: string
+

target

target: string

Name of the parent attribute that contains all the extracted details from the sources.

-

type

type: "url-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "url-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsUserAgentParser.html b/classes/v1.LogsUserAgentParser.html index 2862cebd9ff..0e841bb55e4 100644 --- a/classes/v1.LogsUserAgentParser.html +++ b/classes/v1.LogsUserAgentParser.html @@ -1,13 +1,13 @@ LogsUserAgentParser | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsUserAgentParser

The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing.

-

Hierarchy

  • LogsUserAgentParser

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean
+

Hierarchy

  • LogsUserAgentParser

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

-

Optional isEncoded

isEncoded?: boolean
+

Optional isEncoded

isEncoded?: boolean

Define if the source attribute is URL encoded or not.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the processor.

-

sources

sources: string[]
+

sources

sources: string[]

Array of source attributes.

-

target

target: string
+

target

target: string

Name of the parent attribute that contains all the extracted details from the sources.

-

type

type: "user-agent-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "user-agent-parser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MetricMetadata.html b/classes/v1.MetricMetadata.html index 232868c1f00..7b39cb3a23b 100644 --- a/classes/v1.MetricMetadata.html +++ b/classes/v1.MetricMetadata.html @@ -1,17 +1,17 @@ MetricMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricMetadata

Object with all metric related metadata.

-

Hierarchy

  • MetricMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional description

description?: string
+

Hierarchy

  • MetricMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional description

description?: string

Metric description.

-

Optional integration

integration?: string
+

Optional integration

integration?: string

Name of the integration that sent the metric if applicable.

-

Optional perUnit

perUnit?: string
+

Optional perUnit

perUnit?: string

Per unit of the metric such as second in bytes per second.

-

Optional shortName

shortName?: string
+

Optional shortName

shortName?: string

A more human-readable and abbreviated version of the metric name.

-

Optional statsdInterval

statsdInterval?: number
+

Optional statsdInterval

statsdInterval?: number

StatsD flush interval of the metric in seconds if applicable.

-

Optional type

type?: string
+

Optional type

type?: string

Metric type such as gauge or rate.

-

Optional unit

unit?: string
+

Optional unit

unit?: string

Primary unit of the metric such as byte or operation.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MetricSearchResponse.html b/classes/v1.MetricSearchResponse.html index fb232ef926f..cb2d806d14c 100644 --- a/classes/v1.MetricSearchResponse.html +++ b/classes/v1.MetricSearchResponse.html @@ -1,3 +1,3 @@ MetricSearchResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricSearchResponse

Object containing the list of metrics matching the search query.

-

Hierarchy

  • MetricSearchResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional results

results?: MetricSearchResponseResults

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricSearchResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional results

results?: MetricSearchResponseResults

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MetricSearchResponseResults.html b/classes/v1.MetricSearchResponseResults.html index 02efdbe3e66..83904d23785 100644 --- a/classes/v1.MetricSearchResponseResults.html +++ b/classes/v1.MetricSearchResponseResults.html @@ -1,5 +1,5 @@ MetricSearchResponseResults | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricSearchResponseResults

Search result.

-

Hierarchy

  • MetricSearchResponseResults

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metrics

metrics?: string[]
+

Hierarchy

  • MetricSearchResponseResults

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metrics

metrics?: string[]

List of metrics that match the search query.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MetricsApi.html b/classes/v1.MetricsApi.html index 766d2ab1925..43a19f0c025 100644 --- a/classes/v1.MetricsApi.html +++ b/classes/v1.MetricsApi.html @@ -1,24 +1,24 @@ -MetricsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricsApi

Hierarchy

  • MetricsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MetricsApi(configuration: v1.Configuration, requestFactory?: MetricsApiRequestFactory, responseProcessor?: MetricsApiResponseProcessor): v1.MetricsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: MetricsApiRequestFactory

Private responseProcessor

responseProcessor: MetricsApiResponseProcessor

Methods

getMetricMetadata

listActiveMetrics

listMetrics

Returns Promise<MetricsListResponse>

listMetrics

queryMetrics

Returns Promise<MetricSearchResponse>

queryMetrics

submitMetrics

Returns Promise<MetricsQueryResponse>

submitMetrics

  • The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes). If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: - 64 bits for the timestamp - 32 bits for the value - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size.

    Parameters

    Returns Promise<IntakePayloadAccepted>

updateMetricMetadata

Returns Promise<IntakePayloadAccepted>

updateMetricMetadata

type

type: MonitorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorFormulaAndFunctionEventQueryDefinition.html b/classes/v1.MonitorFormulaAndFunctionEventQueryDefinition.html index 6842bab24de..5d3055665b8 100644 --- a/classes/v1.MonitorFormulaAndFunctionEventQueryDefinition.html +++ b/classes/v1.MonitorFormulaAndFunctionEventQueryDefinition.html @@ -1,9 +1,9 @@ MonitorFormulaAndFunctionEventQueryDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorFormulaAndFunctionEventQueryDefinition

A formula and functions events query.

-

Hierarchy

  • MonitorFormulaAndFunctionEventQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

compute

compute: MonitorFormulaAndFunctionEventQueryDefinitionCompute

dataSource

dataSource: "rum"

Optional groupBy

groupBy?: MonitorFormulaAndFunctionEventQueryGroupBy[]
+

Hierarchy

  • MonitorFormulaAndFunctionEventQueryDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

compute

compute: MonitorFormulaAndFunctionEventQueryDefinitionCompute

dataSource

dataSource: "rum"

Optional groupBy

groupBy?: MonitorFormulaAndFunctionEventQueryGroupBy[]

Group by options.

-

Optional indexes

indexes?: string[]
+

Optional indexes

indexes?: string[]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

-

name

name: string
+

name

name: string

Name of the query for use in formulas.

-

Optional search

search?: MonitorFormulaAndFunctionEventQueryDefinitionSearch

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional search

search?: MonitorFormulaAndFunctionEventQueryDefinitionSearch

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionCompute.html b/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionCompute.html index 6eeb4b357c2..19c32e15d3d 100644 --- a/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionCompute.html +++ b/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionCompute.html @@ -1,7 +1,7 @@ MonitorFormulaAndFunctionEventQueryDefinitionCompute | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorFormulaAndFunctionEventQueryDefinitionCompute

Compute options.

-

Hierarchy

  • MonitorFormulaAndFunctionEventQueryDefinitionCompute

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: MonitorFormulaAndFunctionEventAggregation

Optional interval

interval?: number
+

Hierarchy

  • MonitorFormulaAndFunctionEventQueryDefinitionCompute

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: MonitorFormulaAndFunctionEventAggregation

Optional interval

interval?: number

A time interval in milliseconds.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

Measurable attribute to compute.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionSearch.html b/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionSearch.html index 82faf8ffaf4..643d783b653 100644 --- a/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionSearch.html +++ b/classes/v1.MonitorFormulaAndFunctionEventQueryDefinitionSearch.html @@ -1,5 +1,5 @@ MonitorFormulaAndFunctionEventQueryDefinitionSearch | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorFormulaAndFunctionEventQueryDefinitionSearch

Search options.

-

Hierarchy

  • MonitorFormulaAndFunctionEventQueryDefinitionSearch

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string
+

Hierarchy

  • MonitorFormulaAndFunctionEventQueryDefinitionSearch

Index

Constructors

Properties

Constructors

constructor

Properties

query

query: string

Events search string.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBy.html b/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBy.html index 90615c7dc37..5bec5940008 100644 --- a/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBy.html +++ b/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBy.html @@ -1,7 +1,7 @@ MonitorFormulaAndFunctionEventQueryGroupBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorFormulaAndFunctionEventQueryGroupBy

List of objects used to group by.

-

Hierarchy

  • MonitorFormulaAndFunctionEventQueryGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string
+

Hierarchy

  • MonitorFormulaAndFunctionEventQueryGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string

Event facet.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Number of groups to return.

-

Optional sort

sort?: MonitorFormulaAndFunctionEventQueryGroupBySort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional sort

sort?: MonitorFormulaAndFunctionEventQueryGroupBySort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBySort.html b/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBySort.html index bedce585e23..5efacd63ed1 100644 --- a/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBySort.html +++ b/classes/v1.MonitorFormulaAndFunctionEventQueryGroupBySort.html @@ -1,5 +1,5 @@ MonitorFormulaAndFunctionEventQueryGroupBySort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorFormulaAndFunctionEventQueryGroupBySort

Options for sorting group by results.

-

Hierarchy

  • MonitorFormulaAndFunctionEventQueryGroupBySort

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: MonitorFormulaAndFunctionEventAggregation

Optional metric

metric?: string
+

Hierarchy

  • MonitorFormulaAndFunctionEventQueryGroupBySort

Index

Constructors

Properties

Constructors

constructor

Properties

aggregation

aggregation: MonitorFormulaAndFunctionEventAggregation

Optional metric

metric?: string

Metric used for sorting group by results.

-

Optional order

order?: v1.QuerySortOrder

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional order

order?: v1.QuerySortOrder

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorGroupSearchResponse.html b/classes/v1.MonitorGroupSearchResponse.html index 33ff0468415..8b1f97aa0a3 100644 --- a/classes/v1.MonitorGroupSearchResponse.html +++ b/classes/v1.MonitorGroupSearchResponse.html @@ -1,5 +1,5 @@ MonitorGroupSearchResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorGroupSearchResponse

The response of a monitor group search.

-

Hierarchy

  • MonitorGroupSearchResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional counts

counts?: MonitorGroupSearchResponseCounts

Optional groups

groups?: MonitorGroupSearchResult[]
+

Hierarchy

  • MonitorGroupSearchResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional counts

counts?: MonitorGroupSearchResponseCounts

Optional groups

groups?: MonitorGroupSearchResult[]

The list of found monitor groups.

-

Optional metadata

metadata?: MonitorSearchResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional metadata

metadata?: MonitorSearchResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorGroupSearchResponseCounts.html b/classes/v1.MonitorGroupSearchResponseCounts.html index 98337ba2418..1bd9223958a 100644 --- a/classes/v1.MonitorGroupSearchResponseCounts.html +++ b/classes/v1.MonitorGroupSearchResponseCounts.html @@ -1,7 +1,7 @@ MonitorGroupSearchResponseCounts | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorGroupSearchResponseCounts

The counts of monitor groups per different criteria.

-

Hierarchy

  • MonitorGroupSearchResponseCounts

Index

Constructors

Properties

Constructors

constructor

Properties

Optional status

status?: any[]
+

Hierarchy

  • MonitorGroupSearchResponseCounts

Index

Constructors

Properties

Constructors

constructor

Properties

Optional status

status?: any[]

Search facets.

-

Optional type

type?: any[]
+

Optional type

type?: any[]

Search facets.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorGroupSearchResult.html b/classes/v1.MonitorGroupSearchResult.html index c177c770e0f..8bda1aab163 100644 --- a/classes/v1.MonitorGroupSearchResult.html +++ b/classes/v1.MonitorGroupSearchResult.html @@ -1,15 +1,15 @@ MonitorGroupSearchResult | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorGroupSearchResult

A single monitor group search result.

-

Hierarchy

  • MonitorGroupSearchResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional group

group?: string
+

Hierarchy

  • MonitorGroupSearchResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional group

group?: string

The name of the group.

-

Optional groupTags

groupTags?: string[]
+

Optional groupTags

groupTags?: string[]

The list of tags of the monitor group.

-

Optional lastNodataTs

lastNodataTs?: number
+

Optional lastNodataTs

lastNodataTs?: number

Latest timestamp the monitor group was in NO_DATA state.

-

Optional lastTriggeredTs

lastTriggeredTs?: number
+

Optional lastTriggeredTs

lastTriggeredTs?: number

Latest timestamp the monitor group triggered.

-

Optional monitorId

monitorId?: number
+

Optional monitorId

monitorId?: number

The ID of the monitor.

-

Optional monitorName

monitorName?: string
+

Optional monitorName

monitorName?: string

The name of the monitor.

-

Optional status

status?: MonitorOverallStates

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: MonitorOverallStates

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorOptions.html b/classes/v1.MonitorOptions.html index b56fd81b773..ed3d9b79706 100644 --- a/classes/v1.MonitorOptions.html +++ b/classes/v1.MonitorOptions.html @@ -1,47 +1,47 @@ MonitorOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorOptions

List of options associated with your monitor.

-

Hierarchy

  • MonitorOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: MonitorOptionsAggregation

Optional deviceIds

deviceIds?: MonitorDeviceID[]
+

Hierarchy

  • MonitorOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: MonitorOptionsAggregation

Optional deviceIds

deviceIds?: MonitorDeviceID[]

IDs of the device the Synthetics monitor is running on.

-

Optional enableLogsSample

enableLogsSample?: boolean
+

Optional enableLogsSample

enableLogsSample?: boolean

Whether or not to send a log sample when the log monitor triggers.

-

Optional escalationMessage

escalationMessage?: string
+

Optional escalationMessage

escalationMessage?: string

We recommend using the is_renotify, block in the original message instead. A message to include with a re-notification. Supports the @username notification we allow elsewhere. Not applicable if renotify_interval is None.

-

Optional evaluationDelay

evaluationDelay?: number
+

Optional evaluationDelay

evaluationDelay?: number

Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.

-

Optional groupbySimpleMonitor

groupbySimpleMonitor?: boolean
+

Optional groupbySimpleMonitor

groupbySimpleMonitor?: boolean

Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold.

-

Optional includeTags

includeTags?: boolean
+

Optional includeTags

includeTags?: boolean

A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. Examples - If True, [Triggered on {host:h1}] Monitor Title - If False, [Triggered] Monitor Title

-

Optional locked

locked?: boolean
+

Optional locked

locked?: boolean

Whether or not the monitor is locked (only editable by creator and admins).

-

Optional minFailureDuration

minFailureDuration?: number
+

Optional minFailureDuration

minFailureDuration?: number

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

-

Optional minLocationFailed

minLocationFailed?: number
+

Optional minLocationFailed

minLocationFailed?: number

The minimum number of locations in failure at the same time during at least one moment in the min_failure_duration period (min_location_failed and min_failure_duration are part of the advanced alerting rules - integer, >= 1).

-

Optional newGroupDelay

newGroupDelay?: number
+

Optional newGroupDelay

newGroupDelay?: number

Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.

-

Optional newHostDelay

newHostDelay?: number
+

Optional newHostDelay

newHostDelay?: number

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead.

-

Optional noDataTimeframe

noDataTimeframe?: number
+

Optional noDataTimeframe

noDataTimeframe?: number

The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks.

-

Optional notifyAudit

notifyAudit?: boolean
+

Optional notifyAudit

notifyAudit?: boolean

A Boolean indicating whether tagged users is notified on changes to this monitor.

-

Optional notifyNoData

notifyNoData?: boolean
+

Optional notifyNoData

notifyNoData?: boolean

A Boolean indicating whether this monitor notifies when data stops reporting.

-

Optional renotifyInterval

renotifyInterval?: number
+

Optional renotifyInterval

renotifyInterval?: number

The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved.

-

Optional renotifyOccurrences

renotifyOccurrences?: number
+

Optional renotifyOccurrences

renotifyOccurrences?: number

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

-

Optional renotifyStatuses

renotifyStatuses?: MonitorRenotifyStatusType[]
+

Optional renotifyStatuses

renotifyStatuses?: MonitorRenotifyStatusType[]

The types of monitor statuses for which re-notification messages are sent.

-

Optional requireFullWindow

requireFullWindow?: boolean
+

Optional requireFullWindow

requireFullWindow?: boolean

A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to false for sparse metrics, otherwise some evaluations are skipped. Default is false.

-

Optional silenced

silenced?: {}
+

Optional silenced

silenced?: {}

Information about the downtime applied to the monitor.

-

Type declaration

  • [key: string]: number

Optional syntheticsCheckId

syntheticsCheckId?: string
+

Type declaration

  • [key: string]: number

Optional syntheticsCheckId

syntheticsCheckId?: string

ID of the corresponding Synthetic check.

-

Optional thresholdWindows

thresholdWindows?: MonitorThresholdWindowOptions

Optional thresholds

thresholds?: MonitorThresholds

Optional timeoutH

timeoutH?: number
+

Optional thresholdWindows

thresholdWindows?: MonitorThresholdWindowOptions

Optional thresholds

thresholds?: MonitorThresholds

Optional timeoutH

timeoutH?: number

The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.

-

Optional variables

variables?: MonitorFormulaAndFunctionQueryDefinition[]
+

Optional variables

variables?: MonitorFormulaAndFunctionQueryDefinition[]

List of requests that can be used in the monitor query. This feature is currently in beta.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorOptionsAggregation.html b/classes/v1.MonitorOptionsAggregation.html index 644e840dcf0..cd89920942d 100644 --- a/classes/v1.MonitorOptionsAggregation.html +++ b/classes/v1.MonitorOptionsAggregation.html @@ -1,9 +1,9 @@ MonitorOptionsAggregation | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorOptionsAggregation

Type of aggregation performed in the monitor query.

-

Hierarchy

  • MonitorOptionsAggregation

Index

Constructors

Properties

Constructors

constructor

Properties

Optional groupBy

groupBy?: string
+

Hierarchy

  • MonitorOptionsAggregation

Index

Constructors

Properties

Constructors

constructor

Properties

Optional groupBy

groupBy?: string

Group to break down the monitor on.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

Metric name used in the monitor.

-

Optional type

type?: string
+

Optional type

type?: string

Metric type used in the monitor.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorSearchResponse.html b/classes/v1.MonitorSearchResponse.html index ebc62aac785..c33246e21d8 100644 --- a/classes/v1.MonitorSearchResponse.html +++ b/classes/v1.MonitorSearchResponse.html @@ -1,5 +1,5 @@ MonitorSearchResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorSearchResponse

The response form a monitor search.

-

Hierarchy

  • MonitorSearchResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional counts

counts?: MonitorSearchResponseCounts

Optional metadata

metadata?: MonitorSearchResponseMetadata

Optional monitors

monitors?: MonitorSearchResult[]
+

Hierarchy

  • MonitorSearchResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional counts

counts?: MonitorSearchResponseCounts

Optional metadata

metadata?: MonitorSearchResponseMetadata

Optional monitors

monitors?: MonitorSearchResult[]

The list of found monitors.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorSearchResponseCounts.html b/classes/v1.MonitorSearchResponseCounts.html index 3a3b451ff69..5b89983dd75 100644 --- a/classes/v1.MonitorSearchResponseCounts.html +++ b/classes/v1.MonitorSearchResponseCounts.html @@ -1,11 +1,11 @@ MonitorSearchResponseCounts | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorSearchResponseCounts

The counts of monitors per different criteria.

-

Hierarchy

  • MonitorSearchResponseCounts

Index

Constructors

Properties

Constructors

constructor

Properties

Optional muted

muted?: any[]
+

Hierarchy

  • MonitorSearchResponseCounts

Index

Constructors

Properties

Constructors

constructor

Properties

Optional muted

muted?: any[]

Search facets.

-

Optional status

status?: any[]
+

Optional status

status?: any[]

Search facets.

-

Optional tag

tag?: any[]
+

Optional tag

tag?: any[]

Search facets.

-

Optional type

type?: any[]
+

Optional type

type?: any[]

Search facets.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorSearchResponseMetadata.html b/classes/v1.MonitorSearchResponseMetadata.html index cda2cf122af..fda72518fd7 100644 --- a/classes/v1.MonitorSearchResponseMetadata.html +++ b/classes/v1.MonitorSearchResponseMetadata.html @@ -1,11 +1,11 @@ MonitorSearchResponseMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorSearchResponseMetadata

Metadata about the response.

-

Hierarchy

  • MonitorSearchResponseMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: number
+

Hierarchy

  • MonitorSearchResponseMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: number

The page to start paginating from.

-

Optional pageCount

pageCount?: number
+

Optional pageCount

pageCount?: number

The number of pages.

-

Optional perPage

perPage?: number
+

Optional perPage

perPage?: number

The number of monitors to return per page.

-

Optional totalCount

totalCount?: number
+

Optional totalCount

totalCount?: number

The total number of monitors.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorSearchResult.html b/classes/v1.MonitorSearchResult.html index f36df587400..b740ee9ee56 100644 --- a/classes/v1.MonitorSearchResult.html +++ b/classes/v1.MonitorSearchResult.html @@ -1,23 +1,23 @@ MonitorSearchResult | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorSearchResult

Holds search results.

-

Hierarchy

  • MonitorSearchResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional classification

classification?: string
+

Hierarchy

  • MonitorSearchResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional classification

classification?: string

Classification of the monitor.

-

Optional creator

creator?: v1.Creator

Optional id

id?: number
+

Optional creator

creator?: v1.Creator

Optional id

id?: number

ID of the monitor.

-

Optional lastTriggeredTs

lastTriggeredTs?: number
+

Optional lastTriggeredTs

lastTriggeredTs?: number

Latest timestamp the monitor triggered.

-

Optional metrics

metrics?: string[]
+

Optional metrics

metrics?: string[]

Metrics used by the monitor.

-

Optional name

name?: string
+

Optional name

name?: string

The monitor name.

-

Optional notifications

notifications?: MonitorSearchResultNotification[]
+

Optional notifications

notifications?: MonitorSearchResultNotification[]

The notification triggered by the monitor.

-

Optional orgId

orgId?: number
+

Optional orgId

orgId?: number

The ID of the organization.

-

Optional query

query?: string
+

Optional query

query?: string

The monitor query.

-

Optional scopes

scopes?: string[]
+

Optional scopes

scopes?: string[]

The scope(s) to which the downtime applies, for example host:app2. Provide multiple scopes as a comma-separated list, for example env:dev,env:prod. The resulting downtime applies to sources that matches ALL provided scopes (that is env:dev AND env:prod), NOT any of them.

-

Optional status

status?: MonitorOverallStates

Optional tags

tags?: string[]
+

Optional status

status?: MonitorOverallStates

Optional tags

tags?: string[]

Tags associated with the monitor.

-

Optional type

type?: MonitorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: MonitorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorSearchResultNotification.html b/classes/v1.MonitorSearchResultNotification.html index d252a9bbcb5..fded227d3e1 100644 --- a/classes/v1.MonitorSearchResultNotification.html +++ b/classes/v1.MonitorSearchResultNotification.html @@ -1,7 +1,7 @@ MonitorSearchResultNotification | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorSearchResultNotification

A notification triggered by the monitor.

-

Hierarchy

  • MonitorSearchResultNotification

Index

Constructors

Properties

Constructors

constructor

Properties

Optional handle

handle?: string
+

Hierarchy

  • MonitorSearchResultNotification

Index

Constructors

Properties

Constructors

constructor

Properties

Optional handle

handle?: string

The email address that received the notification.

-

Optional name

name?: string
+

Optional name

name?: string

The username receiving the notification

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorState.html b/classes/v1.MonitorState.html index 06e4caa834c..0150887eb7e 100644 --- a/classes/v1.MonitorState.html +++ b/classes/v1.MonitorState.html @@ -1,5 +1,5 @@ MonitorState | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorState

Wrapper object with the different monitor states.

-

Hierarchy

  • MonitorState

Index

Constructors

Properties

Constructors

constructor

Properties

Optional groups

groups?: {}
+

Hierarchy

  • MonitorState

Index

Constructors

Properties

Constructors

constructor

Properties

Optional groups

groups?: {}

Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on.

Type declaration

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorStateGroup.html b/classes/v1.MonitorStateGroup.html index e97f7be0a18..b8cba7f02fd 100644 --- a/classes/v1.MonitorStateGroup.html +++ b/classes/v1.MonitorStateGroup.html @@ -1,13 +1,13 @@ MonitorStateGroup | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorStateGroup

Monitor state for a single group.

-

Hierarchy

  • MonitorStateGroup

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lastNodataTs

lastNodataTs?: number
+

Hierarchy

  • MonitorStateGroup

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lastNodataTs

lastNodataTs?: number

Latest timestamp the monitor was in NO_DATA state.

-

Optional lastNotifiedTs

lastNotifiedTs?: number
+

Optional lastNotifiedTs

lastNotifiedTs?: number

Latest timestamp of the notification sent for this monitor group.

-

Optional lastResolvedTs

lastResolvedTs?: number
+

Optional lastResolvedTs

lastResolvedTs?: number

Latest timestamp the monitor group was resolved.

-

Optional lastTriggeredTs

lastTriggeredTs?: number
+

Optional lastTriggeredTs

lastTriggeredTs?: number

Latest timestamp the monitor group triggered.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the monitor.

-

Optional status

status?: MonitorOverallStates

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: MonitorOverallStates

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorSummaryWidgetDefinition.html b/classes/v1.MonitorSummaryWidgetDefinition.html index f7cf9c771c4..32070be23de 100644 --- a/classes/v1.MonitorSummaryWidgetDefinition.html +++ b/classes/v1.MonitorSummaryWidgetDefinition.html @@ -1,17 +1,17 @@ MonitorSummaryWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorSummaryWidgetDefinition

The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.

-

Hierarchy

  • MonitorSummaryWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional colorPreference

colorPreference?: WidgetColorPreference

Optional count

count?: number
+

Hierarchy

  • MonitorSummaryWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional colorPreference

colorPreference?: WidgetColorPreference

Optional count

count?: number

The number of monitors to display.

-

Optional displayFormat

displayFormat?: WidgetMonitorSummaryDisplayFormat

Optional hideZeroCounts

hideZeroCounts?: boolean
+

Optional displayFormat

displayFormat?: WidgetMonitorSummaryDisplayFormat

Optional hideZeroCounts

hideZeroCounts?: boolean

Whether to show counts of 0 or not.

-

query

query: string
+

query

query: string

Query to filter the monitors with.

-

Optional showLastTriggered

showLastTriggered?: boolean
+

Optional showLastTriggered

showLastTriggered?: boolean

Whether to show the time that has elapsed since the monitor/group triggered.

-

Optional sort

sort?: WidgetMonitorSummarySort

Optional start

start?: number
+

Optional sort

sort?: WidgetMonitorSummarySort

Optional start

start?: number

The start of the list. Typically 0.

-

Optional summaryType

summaryType?: WidgetSummaryType

Optional title

title?: string
+

Optional summaryType

summaryType?: WidgetSummaryType

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "manage_status"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "manage_status"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorThresholdWindowOptions.html b/classes/v1.MonitorThresholdWindowOptions.html index 2cfb135af20..1f600448777 100644 --- a/classes/v1.MonitorThresholdWindowOptions.html +++ b/classes/v1.MonitorThresholdWindowOptions.html @@ -1,7 +1,7 @@ MonitorThresholdWindowOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorThresholdWindowOptions

Alerting time window options.

-

Hierarchy

  • MonitorThresholdWindowOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional recoveryWindow

recoveryWindow?: string
+

Hierarchy

  • MonitorThresholdWindowOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional recoveryWindow

recoveryWindow?: string

Describes how long an anomalous metric must be normal before the alert recovers.

-

Optional triggerWindow

triggerWindow?: string
+

Optional triggerWindow

triggerWindow?: string

Describes how long a metric must be anomalous before an alert triggers.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorThresholds.html b/classes/v1.MonitorThresholds.html index 136b4a23d4d..489c2456fc9 100644 --- a/classes/v1.MonitorThresholds.html +++ b/classes/v1.MonitorThresholds.html @@ -1,15 +1,15 @@ MonitorThresholds | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorThresholds

List of the different monitor threshold available.

-

Hierarchy

  • MonitorThresholds

Index

Constructors

Properties

Constructors

constructor

Properties

Optional critical

critical?: number
+

Hierarchy

  • MonitorThresholds

Index

Constructors

Properties

Constructors

constructor

Properties

Optional critical

critical?: number

The monitor CRITICAL threshold.

-

Optional criticalRecovery

criticalRecovery?: number
+

Optional criticalRecovery

criticalRecovery?: number

The monitor CRITICAL recovery threshold.

-

Optional ok

ok?: number
+

Optional ok

ok?: number

The monitor OK threshold.

-

Optional unknown

unknown?: number
+

Optional unknown

unknown?: number

The monitor UNKNOWN threshold.

-

Optional warning

warning?: number
+

Optional warning

warning?: number

The monitor WARNING threshold.

-

Optional warningRecovery

warningRecovery?: number
+

Optional warningRecovery

warningRecovery?: number

The monitor WARNING recovery threshold.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorUpdateRequest.html b/classes/v1.MonitorUpdateRequest.html index 6b79694bd1c..8bdc1b412ff 100644 --- a/classes/v1.MonitorUpdateRequest.html +++ b/classes/v1.MonitorUpdateRequest.html @@ -1,25 +1,25 @@ MonitorUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorUpdateRequest

Object describing a monitor update request.

-

Hierarchy

  • MonitorUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date
+

Hierarchy

  • MonitorUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date

Timestamp of the monitor creation.

-

Optional creator

creator?: v1.Creator

Optional deleted

deleted?: Date
+

Optional creator

creator?: v1.Creator

Optional deleted

deleted?: Date

Whether or not the monitor is deleted. (Always null)

-

Optional id

id?: number
+

Optional id

id?: number

ID of this monitor.

-

Optional message

message?: string
+

Optional message

message?: string

A message to include with notifications for this monitor.

-

Optional modified

modified?: Date
+

Optional modified

modified?: Date

Last timestamp when the monitor was edited.

-

Optional multi

multi?: boolean
+

Optional multi

multi?: boolean

Whether or not the monitor is broken down on different groups.

-

Optional name

name?: string
+

Optional name

name?: string

The monitor name.

-

Optional options

options?: MonitorOptions

Optional overallState

overallState?: MonitorOverallStates

Optional priority

priority?: number
+

Optional options

options?: MonitorOptions

Optional overallState

overallState?: MonitorOverallStates

Optional priority

priority?: number

Integer from 1 (high) to 5 (low) indicating alert severity.

-

Optional query

query?: string
+

Optional query

query?: string

The monitor query.

-

Optional restrictedRoles

restrictedRoles?: string[]
+

Optional restrictedRoles

restrictedRoles?: string[]

A list of role identifiers that can be pulled from the Roles API. Cannot be used with locked option.

-

Optional state

state?: MonitorState

Optional tags

tags?: string[]
+

Optional state

state?: MonitorState

Optional tags

tags?: string[]

Tags associated to your monitor.

-

Optional type

type?: MonitorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: MonitorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonitorsApi.html b/classes/v1.MonitorsApi.html index e9ee2694844..34c1c4f6b5d 100644 --- a/classes/v1.MonitorsApi.html +++ b/classes/v1.MonitorsApi.html @@ -1,36 +1,36 @@ -MonitorsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitorsApi

Hierarchy

  • MonitorsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MonitorsApi(configuration: v1.Configuration, requestFactory?: MonitorsApiRequestFactory, responseProcessor?: MonitorsApiResponseProcessor): MonitorsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: MonitorsApiRequestFactory

Private responseProcessor

responseProcessor: MonitorsApiResponseProcessor

Methods

checkCanDeleteMonitor

createMonitor

  • Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: query alert - APM: query alert or trace-analytics alert - composite: composite - custom: service check - event: event alert - forecast: query alert - host: service check - integration: query alert or service check - live process: process alert - logs: log alert - metric: query alert - network: service check - outlier: query alert - process: service check - rum: rum alert - SLO: slo alert - watchdog: event alert - event-v2: event-v2 alert - audit: audit alert #### Query Types Metric Alert Query Example: time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator # - time_aggr: avg, sum, max, min, change, or pct_change - time_window: last_#m (with # between 1 and 10080 depending on the monitor type) or last_#h(with # between 1 and 168 depending on the monitor type) or last_1d, or last_1w - space_aggr: avg, sum, min, or max - tags: one or more tags (comma-separated), or * - key: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - operator: <, <=, >, >=, ==, or != - #: an integer or decimal number used to set the threshold If you are using the _change_ or _pct_change_ time aggregator, instead use change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator # with: - change_aggr change, pct_change - time_aggr avg, sum, max, min Learn more - time_window last\#m (between 1 and 2880 depending on the monitor type), last\_#h (between 1 and 48 depending on the monitor type), or last#d (1 or 2) - timeshift #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0 Service Check Query Example: \"check\".over(tags).last(count).by(group).count_by_status() - check name of the check, for example datadog.agent.up - tags one or more quoted tags (comma-separated), or "*". for example: .over(\"env:prod\", \"role:db\"); over cannot be blank. - count must be at greater than or equal to your max threshold (defined in the options). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, count should be at least 3. - group must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. For example, Postgres integration monitors are tagged by db, host, and port, and Network monitors by host, instance, and url. See Service Checks documentation for more information. Event Alert Query Example: events('sources:nagios status:error,warning priority:normal tags: \"string query\"').rollup(\"count\").last(\"1h\")\" - event, the event query string: - string_query free text query to match against event title and text. - sources event sources (comma-separated). - status event statuses (comma-separated). Valid options: error, warn, and info. - priority event priorities (comma-separated). Valid options: low, normal, all. - host event reporting host (comma-separated). - tags event tags (comma-separated). - excluded_tags excluded event tags (comma-separated). - rollup the stats roll-up method. count is the only supported method now. - last the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. NOTE The Event Alert Query is being deprecated and replaced by the Event V2 Alert Query. For more information, see the Event Migration guide. Event V2 Alert Query Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax. - rollup_method The stats roll-up method - supports count, avg and cardinality. - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48). - operator <, <=, >, >=, ==, or !=. - # an integer or decimal number used to set the threshold. NOTE Only available on US1-FED, US3, US5 and in closed beta on EU and US1. Process Alert Query Example: processes(search).over(tags).rollup('count').last(timeframe) operator # - search free text search string for querying processes. Matching processes match results on the Live Processes page. - tags one or more tags (comma-separated) - timeframe the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - operator <, <=, >, >=, ==, or != - # an integer or decimal number used to set the threshold Logs Alert Query Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax. - index_name For multi-index organizations, the log index in which the request is performed. - rollup_method The stats roll-up method - supports count, avg and cardinality. - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48). - operator <, <=, >, >=, ==, or !=. - # an integer or decimal number used to set the threshold. Composite Query Example: 12345 && 67890, where 12345 and 67890 are the IDs of non-composite monitors * name [required, default = dynamic, based on query]: The name of the alert. * message [required, default = dynamic, based on query]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * tags [optional, default = empty list]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the monitor_tags argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI. SLO Alert Query Example: error_budget(\"slo_id\").over(\"time_window\") operator # - slo_id: The alphanumeric SLO ID of the SLO you are configuring the alert for. - time_window: The time window of the SLO target you wish to alert on. Valid options: 7d, 30d, 90d. - operator: >= or > Audit Alert Query Example: audits(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax. - rollup_method The stats roll-up method - supports count, avg and cardinality. - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48). - operator <, <=, >, >=, ==, or !=. - # an integer or decimal number used to set the threshold. NOTE Only available on US1-FED and in closed beta on US1, EU, US3, and US5. CI Pipelines Alert Query Example: ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator # - query The search query - following the Log search syntax. - rollup_method The stats roll-up method - supports count, avg, and cardinality. - measure For avg and cardinality rollup_method - specify the measure or the facet name you want to use. - time_window #m (between 1 and 2880), #h (between 1 and 48). - operator <, <=, >, >=, ==, or !=. - # an integer or decimal number used to set the threshold. NOTE Only available in closed beta on US1, EU, US3 and US5.

    Parameters

    Returns Promise<Monitor>

deleteMonitor

Returns Promise<Monitor>

deleteMonitor

getMonitor

Returns Promise<DeletedMonitor>

getMonitor

listMonitors

Returns Promise<Monitor>

listMonitors

searchMonitorGroups

Returns Promise<Monitor[]>

searchMonitorGroups

searchMonitors

Returns Promise<MonitorGroupSearchResponse>

searchMonitors

updateMonitor

Returns Promise<MonitorSearchResponse>

updateMonitor

validateMonitor

Returns Promise<Monitor>

validateMonitor

Optional values

values?: MonthlyUsageAttributionValues

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonthlyUsageAttributionMetadata.html b/classes/v1.MonthlyUsageAttributionMetadata.html index fc420f140af..3ba20aa1202 100644 --- a/classes/v1.MonthlyUsageAttributionMetadata.html +++ b/classes/v1.MonthlyUsageAttributionMetadata.html @@ -1,5 +1,5 @@ MonthlyUsageAttributionMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonthlyUsageAttributionMetadata

The object containing document metadata.

-

Hierarchy

  • MonthlyUsageAttributionMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregates

aggregates?: UsageAttributionAggregatesBody[]
+

Hierarchy

  • MonthlyUsageAttributionMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregates

aggregates?: UsageAttributionAggregatesBody[]

An array of available aggregates.

-

Optional pagination

pagination?: MonthlyUsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional pagination

pagination?: MonthlyUsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonthlyUsageAttributionPagination.html b/classes/v1.MonthlyUsageAttributionPagination.html index f1f6e9f98dd..ab32adbf890 100644 --- a/classes/v1.MonthlyUsageAttributionPagination.html +++ b/classes/v1.MonthlyUsageAttributionPagination.html @@ -1,5 +1,5 @@ MonthlyUsageAttributionPagination | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonthlyUsageAttributionPagination

The metadata for the current pagination.

-

Hierarchy

  • MonthlyUsageAttributionPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional nextRecordId

nextRecordId?: string
+

Hierarchy

  • MonthlyUsageAttributionPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional nextRecordId

nextRecordId?: string

The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the next_record_id.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonthlyUsageAttributionResponse.html b/classes/v1.MonthlyUsageAttributionResponse.html index 607346c2292..46a81ef026c 100644 --- a/classes/v1.MonthlyUsageAttributionResponse.html +++ b/classes/v1.MonthlyUsageAttributionResponse.html @@ -1,5 +1,5 @@ MonthlyUsageAttributionResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonthlyUsageAttributionResponse

Response containing the monthly Usage Summary by tag(s).

-

Hierarchy

  • MonthlyUsageAttributionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: MonthlyUsageAttributionMetadata

Optional usage

usage?: MonthlyUsageAttributionBody[]
+

Hierarchy

  • MonthlyUsageAttributionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: MonthlyUsageAttributionMetadata

Optional usage

usage?: MonthlyUsageAttributionBody[]

Get Usage Summary by tag(s).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.MonthlyUsageAttributionValues.html b/classes/v1.MonthlyUsageAttributionValues.html index 702eb39a9fb..6f902915c99 100644 --- a/classes/v1.MonthlyUsageAttributionValues.html +++ b/classes/v1.MonthlyUsageAttributionValues.html @@ -1,63 +1,63 @@ MonthlyUsageAttributionValues | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonthlyUsageAttributionValues

Fields in Usage Summary by tag(s).

-

Hierarchy

  • MonthlyUsageAttributionValues

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiPercentage

apiPercentage?: number
+

Hierarchy

  • MonthlyUsageAttributionValues

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiPercentage

apiPercentage?: number

The percentage of synthetic API test usage by tag(s).

-

Optional apiUsage

apiUsage?: number
+

Optional apiUsage

apiUsage?: number

The synthetic API test usage by tag(s).

-

Optional apmHostPercentage

apmHostPercentage?: number
+

Optional apmHostPercentage

apmHostPercentage?: number

The percentage of APM host usage by tag(s).

-

Optional apmHostUsage

apmHostUsage?: number
+

Optional apmHostUsage

apmHostUsage?: number

The APM host usage by tag(s).

-

Optional browserPercentage

browserPercentage?: number
+

Optional browserPercentage

browserPercentage?: number

The percentage of synthetic browser test usage by tag(s).

-

Optional browserUsage

browserUsage?: number
+

Optional browserUsage

browserUsage?: number

The synthetic browser test usage by tag(s).

-

Optional containerPercentage

containerPercentage?: number
+

Optional containerPercentage

containerPercentage?: number

The percentage of container usage by tag(s).

-

Optional containerUsage

containerUsage?: number
+

Optional containerUsage

containerUsage?: number

The container usage by tag(s).

-

Optional customTimeseriesPercentage

customTimeseriesPercentage?: number
+

Optional customTimeseriesPercentage

customTimeseriesPercentage?: number

The percentage of custom metrics usage by tag(s).

-

Optional customTimeseriesUsage

customTimeseriesUsage?: number
+

Optional customTimeseriesUsage

customTimeseriesUsage?: number

The custom metrics usage by tag(s).

-

Optional estimatedIndexedLogsPercentage

estimatedIndexedLogsPercentage?: number
+

Optional estimatedIndexedLogsPercentage

estimatedIndexedLogsPercentage?: number

The percentage of estimated live indexed logs usage by tag(s). This field is in private beta.

-

Optional estimatedIndexedLogsUsage

estimatedIndexedLogsUsage?: number
+

Optional estimatedIndexedLogsUsage

estimatedIndexedLogsUsage?: number

The estimated live indexed logs usage by tag(s). This field is in private beta.

-

Optional fargatePercentage

fargatePercentage?: number
+

Optional fargatePercentage

fargatePercentage?: number

The percentage of Fargate usage by tags.

-

Optional fargateUsage

fargateUsage?: number
+

Optional fargateUsage

fargateUsage?: number

The Fargate usage by tags.

-

Optional functionsPercentage

functionsPercentage?: number
+

Optional functionsPercentage

functionsPercentage?: number

The percentage of Lambda function usage by tag(s).

-

Optional functionsUsage

functionsUsage?: number
+

Optional functionsUsage

functionsUsage?: number

The Lambda function usage by tag(s).

-

Optional indexedLogsPercentage

indexedLogsPercentage?: number
+

Optional indexedLogsPercentage

indexedLogsPercentage?: number

The percentage of indexed logs usage by tags.

-

Optional indexedLogsUsage

indexedLogsUsage?: number
+

Optional indexedLogsUsage

indexedLogsUsage?: number

The indexed logs usage by tags.

-

Optional infraHostPercentage

infraHostPercentage?: number
+

Optional infraHostPercentage

infraHostPercentage?: number

The percentage of infrastructure host usage by tag(s).

-

Optional infraHostUsage

infraHostUsage?: number
+

Optional infraHostUsage

infraHostUsage?: number

The infrastructure host usage by tag(s).

-

Optional invocationsPercentage

invocationsPercentage?: number
+

Optional invocationsPercentage

invocationsPercentage?: number

The percentage of Lambda invocation usage by tag(s).

-

Optional invocationsUsage

invocationsUsage?: number
+

Optional invocationsUsage

invocationsUsage?: number

The Lambda invocation usage by tag(s).

-

Optional npmHostPercentage

npmHostPercentage?: number
+

Optional npmHostPercentage

npmHostPercentage?: number

The percentage of network host usage by tag(s).

-

Optional npmHostUsage

npmHostUsage?: number
+

Optional npmHostUsage

npmHostUsage?: number

The network host usage by tag(s).

-

Optional profiledContainerPercentage

profiledContainerPercentage?: number
+

Optional profiledContainerPercentage

profiledContainerPercentage?: number

The percentage of profiled container usage by tag(s).

-

Optional profiledContainerUsage

profiledContainerUsage?: number
+

Optional profiledContainerUsage

profiledContainerUsage?: number

The profiled container usage by tag(s).

-

Optional profiledHostPercentage

profiledHostPercentage?: number
+

Optional profiledHostPercentage

profiledHostPercentage?: number

The percentage of profiled hosts usage by tag(s).

-

Optional profiledHostUsage

profiledHostUsage?: number
+

Optional profiledHostUsage

profiledHostUsage?: number

The profiled hosts usage by tag(s).

-

Optional snmpPercentage

snmpPercentage?: number
+

Optional snmpPercentage

snmpPercentage?: number

The percentage of network device usage by tag(s).

-

Optional snmpUsage

snmpUsage?: number
+

Optional snmpUsage

snmpUsage?: number

The network device usage by tag(s).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NoteWidgetDefinition.html b/classes/v1.NoteWidgetDefinition.html index 05a87fc1250..98f14b230de 100644 --- a/classes/v1.NoteWidgetDefinition.html +++ b/classes/v1.NoteWidgetDefinition.html @@ -1,15 +1,15 @@ NoteWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NoteWidgetDefinition

The notes and links widget is similar to free text widget, but allows for more formatting options.

-

Hierarchy

  • NoteWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string
+

Hierarchy

  • NoteWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string

Background color of the note.

-

content

content: string
+

content

content: string

Content of the note.

-

Optional fontSize

fontSize?: string
+

Optional fontSize

fontSize?: string

Size of the text.

-

Optional hasPadding

hasPadding?: boolean
+

Optional hasPadding

hasPadding?: boolean

Whether to add padding or not.

-

Optional showTick

showTick?: boolean
+

Optional showTick

showTick?: boolean

Whether to show a tick or not.

-

Optional textAlign

textAlign?: WidgetTextAlign

Optional tickEdge

tickEdge?: WidgetTickEdge

Optional tickPos

tickPos?: string
+

Optional textAlign

textAlign?: WidgetTextAlign

Optional tickEdge

tickEdge?: WidgetTickEdge

Optional tickPos

tickPos?: string

Where to position the tick on an edge.

-

type

type: "note"

Optional verticalAlign

verticalAlign?: WidgetVerticalAlign

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "note"

Optional verticalAlign

verticalAlign?: WidgetVerticalAlign

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookAbsoluteTime.html b/classes/v1.NotebookAbsoluteTime.html index ce437aaa02a..cf6d3b85971 100644 --- a/classes/v1.NotebookAbsoluteTime.html +++ b/classes/v1.NotebookAbsoluteTime.html @@ -1,9 +1,9 @@ NotebookAbsoluteTime | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookAbsoluteTime

Absolute timeframe.

-

Hierarchy

  • NotebookAbsoluteTime

Index

Constructors

Properties

Constructors

constructor

Properties

end

end: Date
+

Hierarchy

  • NotebookAbsoluteTime

Index

Constructors

Properties

Constructors

constructor

Properties

end

end: Date

The end time.

-

Optional live

live?: boolean
+

Optional live

live?: boolean

Indicates whether the timeframe should be shifted to end at the current time.

-

start

start: Date
+

start

start: Date

The start time.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookAuthor.html b/classes/v1.NotebookAuthor.html index faa5d5aa078..504556ed368 100644 --- a/classes/v1.NotebookAuthor.html +++ b/classes/v1.NotebookAuthor.html @@ -1,21 +1,21 @@ NotebookAuthor | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookAuthor

Attributes of user object returned by the API.

-

Hierarchy

  • NotebookAuthor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • NotebookAuthor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the user.

-

Optional disabled

disabled?: boolean
+

Optional disabled

disabled?: boolean

Whether the user is disabled.

-

Optional email

email?: string
+

Optional email

email?: string

Email of the user.

-

Optional handle

handle?: string
+

Optional handle

handle?: string

Handle of the user.

-

Optional icon

icon?: string
+

Optional icon

icon?: string

URL of the user's icon.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the user.

-

Optional status

status?: string
+

Optional status

status?: string

Status of the user.

-

Optional title

title?: string
+

Optional title

title?: string

Title of the user.

-

Optional verified

verified?: boolean
+

Optional verified

verified?: boolean

Whether the user is verified.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookCellCreateRequest.html b/classes/v1.NotebookCellCreateRequest.html index b8cd32456ad..29a81471d7a 100644 --- a/classes/v1.NotebookCellCreateRequest.html +++ b/classes/v1.NotebookCellCreateRequest.html @@ -1,3 +1,3 @@ NotebookCellCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookCellCreateRequest

The description of a notebook cell create request.

-

Hierarchy

  • NotebookCellCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCellCreateRequestAttributes

type

type: "notebook_cells"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookCellCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCellCreateRequestAttributes

type

type: "notebook_cells"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookCellResponse.html b/classes/v1.NotebookCellResponse.html index c6c3a2c29a1..3f51120d9df 100644 --- a/classes/v1.NotebookCellResponse.html +++ b/classes/v1.NotebookCellResponse.html @@ -1,5 +1,5 @@ NotebookCellResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookCellResponse

The description of a notebook cell response.

-

Hierarchy

  • NotebookCellResponse

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCellResponseAttributes

id

id: string
+

Hierarchy

  • NotebookCellResponse

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCellResponseAttributes

id

id: string

Notebook cell ID.

-

type

type: "notebook_cells"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "notebook_cells"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookCellUpdateRequest.html b/classes/v1.NotebookCellUpdateRequest.html index c593a5ac526..c2361733ed3 100644 --- a/classes/v1.NotebookCellUpdateRequest.html +++ b/classes/v1.NotebookCellUpdateRequest.html @@ -1,5 +1,5 @@ NotebookCellUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookCellUpdateRequest

The description of a notebook cell update request.

-

Hierarchy

  • NotebookCellUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCellUpdateRequestAttributes

id

id: string
+

Hierarchy

  • NotebookCellUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCellUpdateRequestAttributes

id

id: string

Notebook cell ID.

-

type

type: "notebook_cells"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "notebook_cells"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookCreateData.html b/classes/v1.NotebookCreateData.html index 866875aec63..798f788c95b 100644 --- a/classes/v1.NotebookCreateData.html +++ b/classes/v1.NotebookCreateData.html @@ -1,3 +1,3 @@ NotebookCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookCreateData

The data for a notebook create request.

-

Hierarchy

  • NotebookCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCreateDataAttributes

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookCreateDataAttributes

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookCreateDataAttributes.html b/classes/v1.NotebookCreateDataAttributes.html index e4c61216624..70add67c139 100644 --- a/classes/v1.NotebookCreateDataAttributes.html +++ b/classes/v1.NotebookCreateDataAttributes.html @@ -1,7 +1,7 @@ NotebookCreateDataAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookCreateDataAttributes

The data attributes of a notebook.

-

Hierarchy

  • NotebookCreateDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

cells

cells: NotebookCellCreateRequest[]
+

Hierarchy

  • NotebookCreateDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

cells

cells: NotebookCellCreateRequest[]

List of cells to display in the notebook.

-

Optional metadata

metadata?: NotebookMetadata

name

name: string
+

Optional metadata

metadata?: NotebookMetadata

name

name: string

The name of the notebook.

-

Optional status

status?: "published"

time

time: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: "published"

time

time: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookCreateRequest.html b/classes/v1.NotebookCreateRequest.html index b2f5604dd7d..3ae6ca49962 100644 --- a/classes/v1.NotebookCreateRequest.html +++ b/classes/v1.NotebookCreateRequest.html @@ -1,3 +1,3 @@ NotebookCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookCreateRequest

The description of a notebook create request.

-

Hierarchy

  • NotebookCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: NotebookCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: NotebookCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookDistributionCellAttributes.html b/classes/v1.NotebookDistributionCellAttributes.html index ce130d8ddc3..ee26c7446aa 100644 --- a/classes/v1.NotebookDistributionCellAttributes.html +++ b/classes/v1.NotebookDistributionCellAttributes.html @@ -1,3 +1,3 @@ NotebookDistributionCellAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookDistributionCellAttributes

The attributes of a notebook distribution cell.

-

Hierarchy

  • NotebookDistributionCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: DistributionWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookDistributionCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: DistributionWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookHeatMapCellAttributes.html b/classes/v1.NotebookHeatMapCellAttributes.html index 406341256b4..3e67c7442a2 100644 --- a/classes/v1.NotebookHeatMapCellAttributes.html +++ b/classes/v1.NotebookHeatMapCellAttributes.html @@ -1,3 +1,3 @@ NotebookHeatMapCellAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookHeatMapCellAttributes

The attributes of a notebook heatmap cell.

-

Hierarchy

  • NotebookHeatMapCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: HeatMapWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookHeatMapCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: HeatMapWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookLogStreamCellAttributes.html b/classes/v1.NotebookLogStreamCellAttributes.html index 3b4c09fd012..28c2bbea6c6 100644 --- a/classes/v1.NotebookLogStreamCellAttributes.html +++ b/classes/v1.NotebookLogStreamCellAttributes.html @@ -1,3 +1,3 @@ NotebookLogStreamCellAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookLogStreamCellAttributes

The attributes of a notebook log_stream cell.

-

Hierarchy

  • NotebookLogStreamCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: LogStreamWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookLogStreamCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: LogStreamWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookMarkdownCellAttributes.html b/classes/v1.NotebookMarkdownCellAttributes.html index 14135e649d0..cb213e428ba 100644 --- a/classes/v1.NotebookMarkdownCellAttributes.html +++ b/classes/v1.NotebookMarkdownCellAttributes.html @@ -1,3 +1,3 @@ NotebookMarkdownCellAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookMarkdownCellAttributes

The attributes of a notebook markdown cell.

-

Hierarchy

  • NotebookMarkdownCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: NotebookMarkdownCellDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookMarkdownCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: NotebookMarkdownCellDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookMarkdownCellDefinition.html b/classes/v1.NotebookMarkdownCellDefinition.html index f46049d23d8..297e49518e5 100644 --- a/classes/v1.NotebookMarkdownCellDefinition.html +++ b/classes/v1.NotebookMarkdownCellDefinition.html @@ -1,5 +1,5 @@ NotebookMarkdownCellDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookMarkdownCellDefinition

Text in a notebook is formatted with Markdown, which enables the use of headings, subheadings, links, images, lists, and code blocks.

-

Hierarchy

  • NotebookMarkdownCellDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

text

text: string
+

Hierarchy

  • NotebookMarkdownCellDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

text

text: string

The markdown content.

-

type

type: "markdown"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "markdown"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookMetadata.html b/classes/v1.NotebookMetadata.html index 676294b041b..1d4e10e076c 100644 --- a/classes/v1.NotebookMetadata.html +++ b/classes/v1.NotebookMetadata.html @@ -1,7 +1,7 @@ NotebookMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookMetadata

Metadata associated with the notebook.

-

Hierarchy

  • NotebookMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isTemplate

isTemplate?: boolean
+

Hierarchy

  • NotebookMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isTemplate

isTemplate?: boolean

Whether or not the notebook is a template.

-

Optional takeSnapshots

takeSnapshots?: boolean
+

Optional takeSnapshots

takeSnapshots?: boolean

Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs.

-

Optional type

type?: NotebookMetadataType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: NotebookMetadataType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookRelativeTime.html b/classes/v1.NotebookRelativeTime.html index 7b9cbeb27e2..c7583ce1796 100644 --- a/classes/v1.NotebookRelativeTime.html +++ b/classes/v1.NotebookRelativeTime.html @@ -1,3 +1,3 @@ NotebookRelativeTime | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookRelativeTime

Relative timeframe.

-

Hierarchy

  • NotebookRelativeTime

Index

Constructors

Properties

Constructors

constructor

Properties

liveSpan

liveSpan: WidgetLiveSpan

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookRelativeTime

Index

Constructors

Properties

Constructors

constructor

Properties

liveSpan

liveSpan: WidgetLiveSpan

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookResponse.html b/classes/v1.NotebookResponse.html index 4c77948b2ea..9602d151fa4 100644 --- a/classes/v1.NotebookResponse.html +++ b/classes/v1.NotebookResponse.html @@ -1,3 +1,3 @@ NotebookResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookResponse

The description of a notebook response.

-

Hierarchy

  • NotebookResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: NotebookResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: NotebookResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookResponseData.html b/classes/v1.NotebookResponseData.html index 53ec699b834..338c57e91ad 100644 --- a/classes/v1.NotebookResponseData.html +++ b/classes/v1.NotebookResponseData.html @@ -1,5 +1,5 @@ NotebookResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookResponseData

The data for a notebook.

-

Hierarchy

  • NotebookResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookResponseDataAttributes

id

id: number
+

Hierarchy

  • NotebookResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookResponseDataAttributes

id

id: number

Unique notebook ID, assigned when you create the notebook.

-

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookResponseDataAttributes.html b/classes/v1.NotebookResponseDataAttributes.html index 0710104a7ed..14b9b8b08c5 100644 --- a/classes/v1.NotebookResponseDataAttributes.html +++ b/classes/v1.NotebookResponseDataAttributes.html @@ -1,11 +1,11 @@ NotebookResponseDataAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookResponseDataAttributes

The attributes of a notebook.

-

Hierarchy

  • NotebookResponseDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional author

author?: NotebookAuthor

cells

cells: NotebookCellResponse[]
+

Hierarchy

  • NotebookResponseDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional author

author?: NotebookAuthor

cells

cells: NotebookCellResponse[]

List of cells to display in the notebook.

-

Optional created

created?: Date
+

Optional created

created?: Date

UTC time stamp for when the notebook was created.

-

Optional metadata

metadata?: NotebookMetadata

Optional modified

modified?: Date
+

Optional metadata

metadata?: NotebookMetadata

Optional modified

modified?: Date

UTC time stamp for when the notebook was last modified.

-

name

name: string
+

name

name: string

The name of the notebook.

-

Optional status

status?: "published"

time

time: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: "published"

time

time: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookSplitBy.html b/classes/v1.NotebookSplitBy.html index a82aa238768..79b70bd8cda 100644 --- a/classes/v1.NotebookSplitBy.html +++ b/classes/v1.NotebookSplitBy.html @@ -1,7 +1,7 @@ NotebookSplitBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookSplitBy

Object describing how to split the graph to display multiple visualizations per request.

-

Hierarchy

  • NotebookSplitBy

Index

Constructors

Properties

Constructors

constructor

Properties

keys

keys: string[]
+

Hierarchy

  • NotebookSplitBy

Index

Constructors

Properties

Constructors

constructor

Properties

keys

keys: string[]

Keys to split on.

-

tags

tags: string[]
+

tags

tags: string[]

Tags to split on.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookTimeseriesCellAttributes.html b/classes/v1.NotebookTimeseriesCellAttributes.html index 7420f22bedc..5c6765cb18e 100644 --- a/classes/v1.NotebookTimeseriesCellAttributes.html +++ b/classes/v1.NotebookTimeseriesCellAttributes.html @@ -1,3 +1,3 @@ NotebookTimeseriesCellAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookTimeseriesCellAttributes

The attributes of a notebook timeseries cell.

-

Hierarchy

  • NotebookTimeseriesCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: TimeseriesWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookTimeseriesCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: TimeseriesWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookToplistCellAttributes.html b/classes/v1.NotebookToplistCellAttributes.html index ea85b926980..8f73f181248 100644 --- a/classes/v1.NotebookToplistCellAttributes.html +++ b/classes/v1.NotebookToplistCellAttributes.html @@ -1,3 +1,3 @@ NotebookToplistCellAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookToplistCellAttributes

The attributes of a notebook toplist cell.

-

Hierarchy

  • NotebookToplistCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: ToplistWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookToplistCellAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

definition

definition: ToplistWidgetDefinition

Optional graphSize

graphSize?: NotebookGraphSize

Optional splitBy

splitBy?: NotebookSplitBy

Optional time

time?: NotebookCellTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookUpdateData.html b/classes/v1.NotebookUpdateData.html index 81c2831e04e..72ce3aeb4fb 100644 --- a/classes/v1.NotebookUpdateData.html +++ b/classes/v1.NotebookUpdateData.html @@ -1,3 +1,3 @@ NotebookUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookUpdateData

The data for a notebook update request.

-

Hierarchy

  • NotebookUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookUpdateDataAttributes

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebookUpdateDataAttributes

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookUpdateDataAttributes.html b/classes/v1.NotebookUpdateDataAttributes.html index dc12352b628..b65f8bf68a2 100644 --- a/classes/v1.NotebookUpdateDataAttributes.html +++ b/classes/v1.NotebookUpdateDataAttributes.html @@ -1,7 +1,7 @@ NotebookUpdateDataAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookUpdateDataAttributes

The data attributes of a notebook.

-

Hierarchy

  • NotebookUpdateDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

cells

cells: NotebookUpdateCell[]
+

Hierarchy

  • NotebookUpdateDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

cells

cells: NotebookUpdateCell[]

List of cells to display in the notebook.

-

Optional metadata

metadata?: NotebookMetadata

name

name: string
+

Optional metadata

metadata?: NotebookMetadata

name

name: string

The name of the notebook.

-

Optional status

status?: "published"

time

time: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: "published"

time

time: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebookUpdateRequest.html b/classes/v1.NotebookUpdateRequest.html index fca9b12923f..d4f5eebe6e3 100644 --- a/classes/v1.NotebookUpdateRequest.html +++ b/classes/v1.NotebookUpdateRequest.html @@ -1,3 +1,3 @@ NotebookUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebookUpdateRequest

The description of a notebook update request.

-

Hierarchy

  • NotebookUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: NotebookUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebookUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: NotebookUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebooksApi.html b/classes/v1.NotebooksApi.html index ecb2a22fb4e..09b62f93cb4 100644 --- a/classes/v1.NotebooksApi.html +++ b/classes/v1.NotebooksApi.html @@ -1,20 +1,20 @@ -NotebooksApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebooksApi

Hierarchy

  • NotebooksApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new NotebooksApi(configuration: v1.Configuration, requestFactory?: NotebooksApiRequestFactory, responseProcessor?: NotebooksApiResponseProcessor): NotebooksApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: NotebooksApiRequestFactory

Private responseProcessor

responseProcessor: NotebooksApiResponseProcessor

Methods

createNotebook

deleteNotebook

getNotebook

Returns Promise<void>

getNotebook

listNotebooks

Returns Promise<NotebookResponse>

listNotebooks

updateNotebook

Returns Promise<NotebooksResponse>

updateNotebook

Optional meta

meta?: NotebooksResponseMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebooksResponseData.html b/classes/v1.NotebooksResponseData.html index 08d0364ecda..6adca2bf3ad 100644 --- a/classes/v1.NotebooksResponseData.html +++ b/classes/v1.NotebooksResponseData.html @@ -1,5 +1,5 @@ NotebooksResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebooksResponseData

The data for a notebook in get all response.

-

Hierarchy

  • NotebooksResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebooksResponseDataAttributes

id

id: number
+

Hierarchy

  • NotebooksResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: NotebooksResponseDataAttributes

id

id: number

Unique notebook ID, assigned when you create the notebook.

-

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "notebooks"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebooksResponseDataAttributes.html b/classes/v1.NotebooksResponseDataAttributes.html index 10c8cabe4de..e6075bf284b 100644 --- a/classes/v1.NotebooksResponseDataAttributes.html +++ b/classes/v1.NotebooksResponseDataAttributes.html @@ -1,11 +1,11 @@ NotebooksResponseDataAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebooksResponseDataAttributes

The attributes of a notebook in get all response.

-

Hierarchy

  • NotebooksResponseDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional author

author?: NotebookAuthor

Optional cells

cells?: NotebookCellResponse[]
+

Hierarchy

  • NotebooksResponseDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional author

author?: NotebookAuthor

Optional cells

cells?: NotebookCellResponse[]

List of cells to display in the notebook.

-

Optional created

created?: Date
+

Optional created

created?: Date

UTC time stamp for when the notebook was created.

-

Optional metadata

metadata?: NotebookMetadata

Optional modified

modified?: Date
+

Optional metadata

metadata?: NotebookMetadata

Optional modified

modified?: Date

UTC time stamp for when the notebook was last modified.

-

name

name: string
+

name

name: string

The name of the notebook.

-

Optional status

status?: "published"

Optional time

time?: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: "published"

Optional time

time?: NotebookGlobalTime

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebooksResponseMeta.html b/classes/v1.NotebooksResponseMeta.html index 69152e0940f..db78c3b1144 100644 --- a/classes/v1.NotebooksResponseMeta.html +++ b/classes/v1.NotebooksResponseMeta.html @@ -1,3 +1,3 @@ NotebooksResponseMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebooksResponseMeta

Searches metadata returned by the API.

-

Hierarchy

  • NotebooksResponseMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: NotebooksResponsePage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • NotebooksResponseMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: NotebooksResponsePage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.NotebooksResponsePage.html b/classes/v1.NotebooksResponsePage.html index cfcc15b219f..3115068b794 100644 --- a/classes/v1.NotebooksResponsePage.html +++ b/classes/v1.NotebooksResponsePage.html @@ -1,7 +1,7 @@ NotebooksResponsePage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotebooksResponsePage

Pagination metadata returned by the API.

-

Hierarchy

  • NotebooksResponsePage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number
+

Hierarchy

  • NotebooksResponsePage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number

The total number of notebooks that would be returned if the request was not filtered by start and count parameters.

-

Optional totalFilteredCount

totalFilteredCount?: number
+

Optional totalFilteredCount

totalFilteredCount?: number

The total number of notebooks returned.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Organization.html b/classes/v1.Organization.html index 7ffe23a3341..fd664fc1098 100644 --- a/classes/v1.Organization.html +++ b/classes/v1.Organization.html @@ -1,11 +1,11 @@ Organization | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Organization

Create, edit, and manage organizations.

-

Hierarchy

  • Organization

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billing

billing?: OrganizationBilling

Optional created

created?: string
+

Hierarchy

  • Organization

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billing

billing?: OrganizationBilling

Optional created

created?: string

Date of the organization creation.

-

Optional description

description?: string
+

Optional description

description?: string

Description of the organization.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the new child-organization, limited to 32 characters.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The public_id of the organization you are operating within.

-

Optional settings

settings?: OrganizationSettings

Optional subscription

subscription?: OrganizationSubscription

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional settings

settings?: OrganizationSettings

Optional subscription

subscription?: OrganizationSubscription

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationBilling.html b/classes/v1.OrganizationBilling.html index 2a0e3d8fa2d..a58c4720009 100644 --- a/classes/v1.OrganizationBilling.html +++ b/classes/v1.OrganizationBilling.html @@ -1,5 +1,5 @@ OrganizationBilling | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationBilling

A JSON array of billing type.

-

Hierarchy

  • OrganizationBilling

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: string
+

Hierarchy

  • OrganizationBilling

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: string

The type of billing. Only parent_billing is supported.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationCreateBody.html b/classes/v1.OrganizationCreateBody.html index d71f0202ebb..7f4037ab320 100644 --- a/classes/v1.OrganizationCreateBody.html +++ b/classes/v1.OrganizationCreateBody.html @@ -1,5 +1,5 @@ OrganizationCreateBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationCreateBody

Object describing an organization to create.

-

Hierarchy

  • OrganizationCreateBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billing

billing?: OrganizationBilling

name

name: string
+

Hierarchy

  • OrganizationCreateBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billing

billing?: OrganizationBilling

name

name: string

The name of the new child-organization, limited to 32 characters.

-

Optional subscription

subscription?: OrganizationSubscription

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional subscription

subscription?: OrganizationSubscription

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationCreateResponse.html b/classes/v1.OrganizationCreateResponse.html index b853707b16f..32150cf5d12 100644 --- a/classes/v1.OrganizationCreateResponse.html +++ b/classes/v1.OrganizationCreateResponse.html @@ -1,3 +1,3 @@ OrganizationCreateResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationCreateResponse

Response object for an organization creation.

-

Hierarchy

  • OrganizationCreateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKey

apiKey?: ApiKey

Optional applicationKey

applicationKey?: ApplicationKey

Optional org

org?: v1.Organization

Optional user

user?: v1.User

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • OrganizationCreateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKey

apiKey?: ApiKey

Optional applicationKey

applicationKey?: ApplicationKey

Optional org

org?: v1.Organization

Optional user

user?: v1.User

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationListResponse.html b/classes/v1.OrganizationListResponse.html index 8753d8c7272..d5233e01611 100644 --- a/classes/v1.OrganizationListResponse.html +++ b/classes/v1.OrganizationListResponse.html @@ -1,5 +1,5 @@ OrganizationListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationListResponse

Response with the list of organizations.

-

Hierarchy

  • OrganizationListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional orgs

orgs?: v1.Organization[]
+

Hierarchy

  • OrganizationListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional orgs

orgs?: v1.Organization[]

Array of organization objects.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationResponse.html b/classes/v1.OrganizationResponse.html index 70c21187c3b..d0d58a9fedd 100644 --- a/classes/v1.OrganizationResponse.html +++ b/classes/v1.OrganizationResponse.html @@ -1,3 +1,3 @@ OrganizationResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationResponse

Response with an organization.

-

Hierarchy

  • OrganizationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional org

org?: v1.Organization

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • OrganizationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional org

org?: v1.Organization

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationSettings.html b/classes/v1.OrganizationSettings.html index 9a71381f33f..d686e4ce99f 100644 --- a/classes/v1.OrganizationSettings.html +++ b/classes/v1.OrganizationSettings.html @@ -1,13 +1,13 @@ OrganizationSettings | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationSettings

A JSON array of settings.

-

Hierarchy

  • OrganizationSettings

Index

Constructors

Properties

Constructors

constructor

Properties

Optional privateWidgetShare

privateWidgetShare?: boolean
+

Hierarchy

  • OrganizationSettings

Index

Constructors

Properties

Constructors

constructor

Properties

Optional privateWidgetShare

privateWidgetShare?: boolean

Whether or not the organization users can share widgets outside of Datadog.

-

Optional saml

saml?: OrganizationSettingsSaml

Optional samlAutocreateAccessRole

samlAutocreateAccessRole?: AccessRole

Optional samlAutocreateUsersDomains

samlAutocreateUsersDomains?: OrganizationSettingsSamlAutocreateUsersDomains

Optional samlCanBeEnabled

samlCanBeEnabled?: boolean
+

Optional saml

saml?: OrganizationSettingsSaml

Optional samlAutocreateAccessRole

samlAutocreateAccessRole?: AccessRole

Optional samlAutocreateUsersDomains

samlAutocreateUsersDomains?: OrganizationSettingsSamlAutocreateUsersDomains

Optional samlCanBeEnabled

samlCanBeEnabled?: boolean

Whether or not SAML can be enabled for this organization.

-

Optional samlIdpEndpoint

samlIdpEndpoint?: string
+

Optional samlIdpEndpoint

samlIdpEndpoint?: string

Identity provider endpoint for SAML authentication.

-

Optional samlIdpInitiatedLogin

samlIdpInitiatedLogin?: OrganizationSettingsSamlIdpInitiatedLogin

Optional samlIdpMetadataUploaded

samlIdpMetadataUploaded?: boolean
+

Optional samlIdpInitiatedLogin

samlIdpInitiatedLogin?: OrganizationSettingsSamlIdpInitiatedLogin

Optional samlIdpMetadataUploaded

samlIdpMetadataUploaded?: boolean

Whether or not a SAML identity provider metadata file was provided to the Datadog organization.

-

Optional samlLoginUrl

samlLoginUrl?: string
+

Optional samlLoginUrl

samlLoginUrl?: string

URL for SAML logging.

-

Optional samlStrictMode

samlStrictMode?: OrganizationSettingsSamlStrictMode

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional samlStrictMode

samlStrictMode?: OrganizationSettingsSamlStrictMode

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationSettingsSaml.html b/classes/v1.OrganizationSettingsSaml.html index 2a07e1eec8f..fb1b240ebbb 100644 --- a/classes/v1.OrganizationSettingsSaml.html +++ b/classes/v1.OrganizationSettingsSaml.html @@ -1,5 +1,5 @@ OrganizationSettingsSaml | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationSettingsSaml

Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.

-

Hierarchy

  • OrganizationSettingsSaml

Index

Constructors

Properties

Constructors

constructor

Properties

Optional enabled

enabled?: boolean
+

Hierarchy

  • OrganizationSettingsSaml

Index

Constructors

Properties

Constructors

constructor

Properties

Optional enabled

enabled?: boolean

Whether or not SAML is enabled for this organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationSettingsSamlAutocreateUsersDomains.html b/classes/v1.OrganizationSettingsSamlAutocreateUsersDomains.html index f32c6a4ad8e..b96c9f02a94 100644 --- a/classes/v1.OrganizationSettingsSamlAutocreateUsersDomains.html +++ b/classes/v1.OrganizationSettingsSamlAutocreateUsersDomains.html @@ -1,7 +1,7 @@ OrganizationSettingsSamlAutocreateUsersDomains | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationSettingsSamlAutocreateUsersDomains

Has two properties, enabled (boolean) and domains, which is a list of domains without the @ symbol.

-

Hierarchy

  • OrganizationSettingsSamlAutocreateUsersDomains

Index

Constructors

Properties

Constructors

constructor

Properties

Optional domains

domains?: string[]
+

Hierarchy

  • OrganizationSettingsSamlAutocreateUsersDomains

Index

Constructors

Properties

Constructors

constructor

Properties

Optional domains

domains?: string[]

List of domains where the SAML automated user creation is enabled.

-

Optional enabled

enabled?: boolean
+

Optional enabled

enabled?: boolean

Whether or not the automated user creation based on SAML domain is enabled.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationSettingsSamlIdpInitiatedLogin.html b/classes/v1.OrganizationSettingsSamlIdpInitiatedLogin.html index 3473e2871b3..384fe54d196 100644 --- a/classes/v1.OrganizationSettingsSamlIdpInitiatedLogin.html +++ b/classes/v1.OrganizationSettingsSamlIdpInitiatedLogin.html @@ -1,5 +1,5 @@ OrganizationSettingsSamlIdpInitiatedLogin | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationSettingsSamlIdpInitiatedLogin

Has one property enabled (boolean).

-

Hierarchy

  • OrganizationSettingsSamlIdpInitiatedLogin

Index

Constructors

Properties

Constructors

constructor

Properties

Optional enabled

enabled?: boolean
+

Hierarchy

  • OrganizationSettingsSamlIdpInitiatedLogin

Index

Constructors

Properties

Constructors

constructor

Properties

Optional enabled

enabled?: boolean

Whether SAML IdP initiated login is enabled, learn more in the SAML documentation.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationSettingsSamlStrictMode.html b/classes/v1.OrganizationSettingsSamlStrictMode.html index f3e8199a736..3aa9eeb1f30 100644 --- a/classes/v1.OrganizationSettingsSamlStrictMode.html +++ b/classes/v1.OrganizationSettingsSamlStrictMode.html @@ -1,5 +1,5 @@ OrganizationSettingsSamlStrictMode | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationSettingsSamlStrictMode

Has one property enabled (boolean).

-

Hierarchy

  • OrganizationSettingsSamlStrictMode

Index

Constructors

Properties

Constructors

constructor

Properties

Optional enabled

enabled?: boolean
+

Hierarchy

  • OrganizationSettingsSamlStrictMode

Index

Constructors

Properties

Constructors

constructor

Properties

Optional enabled

enabled?: boolean

Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the SAML Strict documentation.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationSubscription.html b/classes/v1.OrganizationSubscription.html index 7e024dbb6d8..83ea9a305c5 100644 --- a/classes/v1.OrganizationSubscription.html +++ b/classes/v1.OrganizationSubscription.html @@ -1,5 +1,5 @@ OrganizationSubscription | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationSubscription

Subscription definition.

-

Hierarchy

  • OrganizationSubscription

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: string
+

Hierarchy

  • OrganizationSubscription

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: string

The subscription type. Types available are trial, free, and pro.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.OrganizationsApi.html b/classes/v1.OrganizationsApi.html index 9d41aa2a0ff..dab063cfb1a 100644 --- a/classes/v1.OrganizationsApi.html +++ b/classes/v1.OrganizationsApi.html @@ -1,18 +1,18 @@ -OrganizationsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationsApi

Hierarchy

  • OrganizationsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new OrganizationsApi(configuration: v1.Configuration, requestFactory?: OrganizationsApiRequestFactory, responseProcessor?: OrganizationsApiResponseProcessor): OrganizationsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: OrganizationsApiRequestFactory

Private responseProcessor

responseProcessor: OrganizationsApiResponseProcessor

Methods

createChildOrg

getOrg

listOrgs

Returns Promise<OrganizationResponse>

listOrgs

updateOrg

updateOrg

uploadIdPForOrg

Returns Promise<OrganizationResponse>

uploadIdPForOrg

getPagerDutyIntegrationService

updatePagerDutyIntegrationService

Returns Promise<PagerDutyServiceName>

updatePagerDutyIntegrationService

type

type: "query_value"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.QueryValueWidgetRequest.html b/classes/v1.QueryValueWidgetRequest.html index fd5e85b68cf..b4a568172f6 100644 --- a/classes/v1.QueryValueWidgetRequest.html +++ b/classes/v1.QueryValueWidgetRequest.html @@ -1,11 +1,11 @@ QueryValueWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryValueWidgetRequest

Updated query value widget.

-

Hierarchy

  • QueryValueWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: WidgetAggregator

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]
+

Hierarchy

  • QueryValueWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: WidgetAggregator

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]

List of conditional formats.

-

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]
+

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

TODO.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.RequestContext.html b/classes/v1.RequestContext.html index 397f2cba48f..b4966596c95 100644 --- a/classes/v1.RequestContext.html +++ b/classes/v1.RequestContext.html @@ -1,20 +1,20 @@ RequestContext | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequestContext

Represents an HTTP request context

-

Hierarchy

  • RequestContext

Index

Constructors

Properties

Methods

Constructors

constructor

Hierarchy

  • RequestContext

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private body

body: v1.RequestBody = undefined

Private headers

headers: {} = ...

Type declaration

  • [key: string]: string

Private httpConfig

httpConfig: v1.HttpConfiguration = {}

Private url

url: URLParse

Methods

addCookie

  • addCookie(name: string, value: string): void

Returns v1.RequestContext

Properties

Private body

body: v1.RequestBody = undefined

Private headers

headers: {} = ...

Type declaration

  • [key: string]: string

Private httpConfig

httpConfig: v1.HttpConfiguration = {}

Private url

url: URLParse

Methods

addCookie

  • addCookie(name: string, value: string): void

getBody

getHeaders

  • getHeaders(): {}

getHttpConfig

getHttpMethod

getUrl

  • getUrl(): string

setBody

getBody

getHeaders

  • getHeaders(): {}

getHttpConfig

getHttpMethod

getUrl

  • getUrl(): string

setBody

setHeaderParam

  • setHeaderParam(key: string, value: string): void

setHttpConfig

setQueryParam

  • setQueryParam(name: string, value: string): void

setUrl

  • setUrl(url: string): void

Returns void

setHeaderParam

  • setHeaderParam(key: string, value: string): void

setHttpConfig

setQueryParam

  • setQueryParam(name: string, value: string): void

setUrl

  • setUrl(url: string): void

Legend

  • Constructor
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ResponseContext.html b/classes/v1.ResponseContext.html index e70792f3bdd..a6603a62303 100644 --- a/classes/v1.ResponseContext.html +++ b/classes/v1.ResponseContext.html @@ -1,4 +1,4 @@ -ResponseContext | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResponseContext

Hierarchy

  • ResponseContext

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: v1.ResponseBody

headers

headers: {}

Type declaration

  • [key: string]: string

httpStatusCode

httpStatusCode: number

Methods

getBodyAsFile

getParsedHeader

  • getParsedHeader(headerName: string): {}

timeframe

timeframe: SLOErrorTimeframe

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOBulkDeleteResponse.html b/classes/v1.SLOBulkDeleteResponse.html index cc0a1c80cef..49810918d75 100644 --- a/classes/v1.SLOBulkDeleteResponse.html +++ b/classes/v1.SLOBulkDeleteResponse.html @@ -1,5 +1,5 @@ SLOBulkDeleteResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOBulkDeleteResponse

The bulk partial delete service level objective object endpoint response. This endpoint operates on multiple service level objective objects, so it may be partially successful. In such cases, the "data" and "error" fields in this response indicate which deletions succeeded and failed.

-

Hierarchy

  • SLOBulkDeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOBulkDeleteResponseData

Optional errors

errors?: SLOBulkDeleteError[]
+

Hierarchy

  • SLOBulkDeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOBulkDeleteResponseData

Optional errors

errors?: SLOBulkDeleteError[]

Array of errors object returned.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOBulkDeleteResponseData.html b/classes/v1.SLOBulkDeleteResponseData.html index 9096bba106f..ad43fae9051 100644 --- a/classes/v1.SLOBulkDeleteResponseData.html +++ b/classes/v1.SLOBulkDeleteResponseData.html @@ -1,7 +1,7 @@ SLOBulkDeleteResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOBulkDeleteResponseData

An array of service level objective objects.

-

Hierarchy

  • SLOBulkDeleteResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deleted

deleted?: string[]
+

Hierarchy

  • SLOBulkDeleteResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deleted

deleted?: string[]

An array of service level objective object IDs that indicates which objects that were completely deleted.

-

Optional updated

updated?: string[]
+

Optional updated

updated?: string[]

An array of service level objective object IDs that indicates which objects that were modified (objects for which at least one threshold was deleted, but that were not completely deleted).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrection.html b/classes/v1.SLOCorrection.html index 11701f1c64e..371bc555476 100644 --- a/classes/v1.SLOCorrection.html +++ b/classes/v1.SLOCorrection.html @@ -1,5 +1,5 @@ SLOCorrection | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrection

The response object of a list of SLO corrections.

-

Hierarchy

  • SLOCorrection

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SLOCorrectionResponseAttributes

Optional id

id?: string
+

Hierarchy

  • SLOCorrection

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SLOCorrectionResponseAttributes

Optional id

id?: string

The ID of the SLO correction.

-

Optional type

type?: "correction"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "correction"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionCreateData.html b/classes/v1.SLOCorrectionCreateData.html index 14d6bff478c..5179fbe7f6e 100644 --- a/classes/v1.SLOCorrectionCreateData.html +++ b/classes/v1.SLOCorrectionCreateData.html @@ -1,3 +1,3 @@ SLOCorrectionCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionCreateData

The data object associated with the SLO correction to be created.

-

Hierarchy

  • SLOCorrectionCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SLOCorrectionCreateRequestAttributes

type

type: "correction"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SLOCorrectionCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SLOCorrectionCreateRequestAttributes

type

type: "correction"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionCreateRequest.html b/classes/v1.SLOCorrectionCreateRequest.html index a4077cad29e..13d2e1d229f 100644 --- a/classes/v1.SLOCorrectionCreateRequest.html +++ b/classes/v1.SLOCorrectionCreateRequest.html @@ -1,3 +1,3 @@ SLOCorrectionCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionCreateRequest

An object that defines a correction to be applied to an SLO.

-

Hierarchy

  • SLOCorrectionCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrectionCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SLOCorrectionCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrectionCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionCreateRequestAttributes.html b/classes/v1.SLOCorrectionCreateRequestAttributes.html index 3ed8ff28e84..e7e7ae93aab 100644 --- a/classes/v1.SLOCorrectionCreateRequestAttributes.html +++ b/classes/v1.SLOCorrectionCreateRequestAttributes.html @@ -1,17 +1,17 @@ SLOCorrectionCreateRequestAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionCreateRequestAttributes

The attribute object associated with the SLO correction to be created.

-

Hierarchy

  • SLOCorrectionCreateRequestAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

category

category: SLOCorrectionCategory

Optional description

description?: string
+

Hierarchy

  • SLOCorrectionCreateRequestAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

category

category: SLOCorrectionCategory

Optional description

description?: string

Description of the correction being made.

-

Optional duration

duration?: number
+

Optional duration

duration?: number

Length of time (in seconds) for a specified rrule recurring SLO correction.

-

Optional end

end?: number
+

Optional end

end?: number

Ending time of the correction in epoch seconds.

-

Optional rrule

rrule?: string
+

Optional rrule

rrule?: string

The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections are FREQ, INTERVAL, COUNT and UNTIL.

-

sloId

sloId: string
+

sloId

sloId: string

ID of the SLO that this correction will be applied to.

-

start

start: number
+

start

start: number

Starting time of the correction in epoch seconds.

-

Optional timezone

timezone?: string
+

Optional timezone

timezone?: string

The timezone to display in the UI for the correction times (defaults to "UTC").

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionListResponse.html b/classes/v1.SLOCorrectionListResponse.html index d80a078eb07..44e7c67b0ad 100644 --- a/classes/v1.SLOCorrectionListResponse.html +++ b/classes/v1.SLOCorrectionListResponse.html @@ -1,5 +1,5 @@ SLOCorrectionListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionListResponse

A list of SLO correction objects.

-

Hierarchy

  • SLOCorrectionListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrection[]
+

Hierarchy

  • SLOCorrectionListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrection[]

The list of of SLO corrections objects.

-

Optional meta

meta?: v1.ResponseMetaAttributes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional meta

meta?: v1.ResponseMetaAttributes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionResponse.html b/classes/v1.SLOCorrectionResponse.html index adcc3d1a21a..8735870e93d 100644 --- a/classes/v1.SLOCorrectionResponse.html +++ b/classes/v1.SLOCorrectionResponse.html @@ -1,3 +1,3 @@ SLOCorrectionResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionResponse

The response object of an SLO correction.

-

Hierarchy

  • SLOCorrectionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrection

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SLOCorrectionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrection

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionResponseAttributes.html b/classes/v1.SLOCorrectionResponseAttributes.html index 9f139a9b776..66cf9af825a 100644 --- a/classes/v1.SLOCorrectionResponseAttributes.html +++ b/classes/v1.SLOCorrectionResponseAttributes.html @@ -1,21 +1,21 @@ SLOCorrectionResponseAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionResponseAttributes

The attribute object associated with the SLO correction.

-

Hierarchy

  • SLOCorrectionResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional category

category?: SLOCorrectionCategory

Optional createdAt

createdAt?: number
+

Hierarchy

  • SLOCorrectionResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional category

category?: SLOCorrectionCategory

Optional createdAt

createdAt?: number

The epoch timestamp of when the correction was created at

-

Optional creator

creator?: v1.Creator

Optional description

description?: string
+

Optional creator

creator?: v1.Creator

Optional description

description?: string

Description of the correction being made.

-

Optional duration

duration?: number
+

Optional duration

duration?: number

Length of time (in seconds) for a specified rrule recurring SLO correction.

-

Optional end

end?: number
+

Optional end

end?: number

Ending time of the correction in epoch seconds.

-

Optional modifiedAt

modifiedAt?: number
+

Optional modifiedAt

modifiedAt?: number

The epoch timestamp of when the correction was modified at

-

Optional modifier

modifier?: SLOCorrectionResponseAttributesModifier

Optional rrule

rrule?: string
+

Optional modifier

modifier?: SLOCorrectionResponseAttributesModifier

Optional rrule

rrule?: string

The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections are FREQ, INTERVAL, COUNT and UNTIL.

-

Optional sloId

sloId?: string
+

Optional sloId

sloId?: string

ID of the SLO that this correction will be applied to.

-

Optional start

start?: number
+

Optional start

start?: number

Starting time of the correction in epoch seconds.

-

Optional timezone

timezone?: string
+

Optional timezone

timezone?: string

The timezone to display in the UI for the correction times (defaults to "UTC").

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionResponseAttributesModifier.html b/classes/v1.SLOCorrectionResponseAttributesModifier.html index 6dec9b42d53..6f6bf9f583c 100644 --- a/classes/v1.SLOCorrectionResponseAttributesModifier.html +++ b/classes/v1.SLOCorrectionResponseAttributesModifier.html @@ -1,9 +1,9 @@ SLOCorrectionResponseAttributesModifier | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionResponseAttributesModifier

Modifier of the object.

-

Hierarchy

  • SLOCorrectionResponseAttributesModifier

Index

Constructors

Properties

Constructors

constructor

Properties

Optional email

email?: string
+

Hierarchy

  • SLOCorrectionResponseAttributesModifier

Index

Constructors

Properties

Constructors

constructor

Properties

Optional email

email?: string

Email of the Modifier.

-

Optional handle

handle?: string
+

Optional handle

handle?: string

Handle of the Modifier.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the Modifier.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionUpdateData.html b/classes/v1.SLOCorrectionUpdateData.html index 63f5f13ee2d..d69dc628d3d 100644 --- a/classes/v1.SLOCorrectionUpdateData.html +++ b/classes/v1.SLOCorrectionUpdateData.html @@ -1,3 +1,3 @@ SLOCorrectionUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionUpdateData

The data object associated with the SLO correction to be updated.

-

Hierarchy

  • SLOCorrectionUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SLOCorrectionUpdateRequestAttributes

Optional type

type?: "correction"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SLOCorrectionUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SLOCorrectionUpdateRequestAttributes

Optional type

type?: "correction"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionUpdateRequest.html b/classes/v1.SLOCorrectionUpdateRequest.html index 28f6309ded6..84e99f6d091 100644 --- a/classes/v1.SLOCorrectionUpdateRequest.html +++ b/classes/v1.SLOCorrectionUpdateRequest.html @@ -1,3 +1,3 @@ SLOCorrectionUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionUpdateRequest

An object that defines a correction to be applied to an SLO.

-

Hierarchy

  • SLOCorrectionUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrectionUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SLOCorrectionUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOCorrectionUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOCorrectionUpdateRequestAttributes.html b/classes/v1.SLOCorrectionUpdateRequestAttributes.html index 328d85e08c1..8c05f5f4c98 100644 --- a/classes/v1.SLOCorrectionUpdateRequestAttributes.html +++ b/classes/v1.SLOCorrectionUpdateRequestAttributes.html @@ -1,15 +1,15 @@ SLOCorrectionUpdateRequestAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOCorrectionUpdateRequestAttributes

The attribute object associated with the SLO correction to be updated.

-

Hierarchy

  • SLOCorrectionUpdateRequestAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional category

category?: SLOCorrectionCategory

Optional description

description?: string
+

Hierarchy

  • SLOCorrectionUpdateRequestAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional category

category?: SLOCorrectionCategory

Optional description

description?: string

Description of the correction being made.

-

Optional duration

duration?: number
+

Optional duration

duration?: number

Length of time (in seconds) for a specified rrule recurring SLO correction.

-

Optional end

end?: number
+

Optional end

end?: number

Ending time of the correction in epoch seconds.

-

Optional rrule

rrule?: string
+

Optional rrule

rrule?: string

The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections are FREQ, INTERVAL, COUNT and UNTIL.

-

Optional start

start?: number
+

Optional start

start?: number

Starting time of the correction in epoch seconds.

-

Optional timezone

timezone?: string
+

Optional timezone

timezone?: string

The timezone to display in the UI for the correction times (defaults to "UTC").

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLODeleteResponse.html b/classes/v1.SLODeleteResponse.html index 4ebdc9a1146..19b878b72b0 100644 --- a/classes/v1.SLODeleteResponse.html +++ b/classes/v1.SLODeleteResponse.html @@ -1,7 +1,7 @@ SLODeleteResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLODeleteResponse

A response list of all service level objective deleted.

-

Hierarchy

  • SLODeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: string[]
+

Hierarchy

  • SLODeleteResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: string[]

An array containing the ID of the deleted service level objective object.

-

Optional errors

errors?: {}
+

Optional errors

errors?: {}

An dictionary containing the ID of the SLO as key and a deletion error as value.

Type declaration

  • [key: string]: string

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryMetrics.html b/classes/v1.SLOHistoryMetrics.html index 9d046061457..9f007162440 100644 --- a/classes/v1.SLOHistoryMetrics.html +++ b/classes/v1.SLOHistoryMetrics.html @@ -1,15 +1,15 @@ SLOHistoryMetrics | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryMetrics

A metric based SLO history response. This is not included in responses for monitor based SLOs.

-

Hierarchy

  • SLOHistoryMetrics

Index

Constructors

Properties

Constructors

constructor

Properties

denominator

denominator: SLOHistoryMetricsSeries

interval

interval: number
+

Hierarchy

  • SLOHistoryMetrics

Index

Constructors

Properties

Constructors

constructor

Properties

denominator

denominator: SLOHistoryMetricsSeries

interval

interval: number

The aggregated query interval for the series data. It's implicit based on the query time window.

-

Optional message

message?: string
+

Optional message

message?: string

Optional message if there are specific query issues/warnings.

-

numerator

numerator: SLOHistoryMetricsSeries

query

query: string
+

numerator

numerator: SLOHistoryMetricsSeries

query

query: string

The combined numerator and denominator query CSV.

-

resType

resType: string
+

resType

resType: string

The series result type. This mimics batch_query response type.

-

respVersion

respVersion: number
+

respVersion

respVersion: number

The series response version type. This mimics batch_query response type.

-

times

times: number[]
+

times

times: number[]

An array of query timestamps in EPOCH milliseconds

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryMetricsSeries.html b/classes/v1.SLOHistoryMetricsSeries.html index b05ee550849..15628e2a04c 100644 --- a/classes/v1.SLOHistoryMetricsSeries.html +++ b/classes/v1.SLOHistoryMetricsSeries.html @@ -1,9 +1,9 @@ SLOHistoryMetricsSeries | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryMetricsSeries

A representation of metric based SLO time series for the provided queries. This is the same response type from batch_query endpoint.

-

Hierarchy

  • SLOHistoryMetricsSeries

Index

Constructors

Properties

Constructors

constructor

Properties

count

count: number
+

Hierarchy

  • SLOHistoryMetricsSeries

Index

Constructors

Properties

Constructors

constructor

Properties

count

count: number

Count of submitted metrics.

-

Optional metadata

metadata?: SLOHistoryMetricsSeriesMetadata

sum

sum: number
+

Optional metadata

metadata?: SLOHistoryMetricsSeriesMetadata

sum

sum: number

Total sum of the query.

-

values

values: number[]
+

values

values: number[]

The query values for each metric.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryMetricsSeriesMetadata.html b/classes/v1.SLOHistoryMetricsSeriesMetadata.html index 1e21c7ac8f9..cec3b151e1f 100644 --- a/classes/v1.SLOHistoryMetricsSeriesMetadata.html +++ b/classes/v1.SLOHistoryMetricsSeriesMetadata.html @@ -1,15 +1,15 @@ SLOHistoryMetricsSeriesMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryMetricsSeriesMetadata

Query metadata.

-

Hierarchy

  • SLOHistoryMetricsSeriesMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggr

aggr?: string
+

Hierarchy

  • SLOHistoryMetricsSeriesMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggr

aggr?: string

Query aggregator function.

-

Optional expression

expression?: string
+

Optional expression

expression?: string

Query expression.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

Query metric used.

-

Optional queryIndex

queryIndex?: number
+

Optional queryIndex

queryIndex?: number

Query index from original combined query.

-

Optional scope

scope?: string
+

Optional scope

scope?: string

Query scope.

-

Optional unit

unit?: SLOHistoryMetricsSeriesMetadataUnit[]
+

Optional unit

unit?: SLOHistoryMetricsSeriesMetadataUnit[]

An array of metric units that contains up to two unit objects. For example, bytes represents one unit object and bytes per second represents two unit objects. If a metric query only has one unit object, the second array element is null.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryMetricsSeriesMetadataUnit.html b/classes/v1.SLOHistoryMetricsSeriesMetadataUnit.html index 3e8f3ae8283..aa654673e10 100644 --- a/classes/v1.SLOHistoryMetricsSeriesMetadataUnit.html +++ b/classes/v1.SLOHistoryMetricsSeriesMetadataUnit.html @@ -1,15 +1,15 @@ SLOHistoryMetricsSeriesMetadataUnit | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryMetricsSeriesMetadataUnit

An Object of metric units.

-

Hierarchy

  • SLOHistoryMetricsSeriesMetadataUnit

Index

Constructors

Properties

Constructors

constructor

Properties

Optional family

family?: string
+

Hierarchy

  • SLOHistoryMetricsSeriesMetadataUnit

Index

Constructors

Properties

Constructors

constructor

Properties

Optional family

family?: string

The family of metric unit, for example bytes is the family for kibibyte, byte, and bit units.

-

Optional id

id?: number
+

Optional id

id?: number

The ID of the metric unit.

-

Optional name

name?: string
+

Optional name

name?: string

The unit of the metric, for instance byte.

-

Optional plural

plural?: string
+

Optional plural

plural?: string

The plural Unit of metric, for instance bytes.

-

Optional scaleFactor

scaleFactor?: number
+

Optional scaleFactor

scaleFactor?: number

The scale factor of metric unit, for instance 1.0.

-

Optional shortName

shortName?: string
+

Optional shortName

shortName?: string

A shorter and abbreviated version of the metric unit, for instance B.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryMonitor.html b/classes/v1.SLOHistoryMonitor.html index 4b8d36509fb..6802a0cb41b 100644 --- a/classes/v1.SLOHistoryMonitor.html +++ b/classes/v1.SLOHistoryMonitor.html @@ -1,27 +1,27 @@ SLOHistoryMonitor | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryMonitor

An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

-

Hierarchy

  • SLOHistoryMonitor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional errorBudgetRemaining

errorBudgetRemaining?: {}
+

Hierarchy

  • SLOHistoryMonitor

Index

Constructors

Properties

Constructors

constructor

Properties

Optional errorBudgetRemaining

errorBudgetRemaining?: {}

A mapping of threshold timeframe to the remaining error budget.

-

Type declaration

  • [key: string]: number

Optional errors

errors?: SLOHistoryResponseErrorWithType[]
+

Type declaration

  • [key: string]: number

Optional errors

errors?: SLOHistoryResponseErrorWithType[]

An array of error objects returned while querying the history data for the service level objective.

-

Optional group

group?: string
+

Optional group

group?: string

For groups in a grouped SLO, this is the group name.

-

Optional history

history?: number[][]
+

Optional history

history?: number[][]

For monitor based SLOs, this includes the aggregated history as arrays that include time series and uptime data where 0=monitor is in OK state and 1=monitor is in alert state.

-

Optional monitorModified

monitorModified?: number
+

Optional monitorModified

monitorModified?: number

For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

-

Optional monitorType

monitorType?: string
+

Optional monitorType

monitorType?: string

For monitor based SLOs, this describes the type of monitor.

-

Optional name

name?: string
+

Optional name

name?: string

For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.

-

Optional precision

precision?: number
+

Optional precision

precision?: number

The amount of decimal places the SLI value is accurate to for the given from && to timestamp. Use span_precision instead.

-

Optional preview

preview?: boolean
+

Optional preview

preview?: boolean

For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime calculation.

-

Optional sliValue

sliValue?: number
+

Optional sliValue

sliValue?: number

The current SLI value of the SLO over the history window.

-

Optional spanPrecision

spanPrecision?: number
+

Optional spanPrecision

spanPrecision?: number

The amount of decimal places the SLI value is accurate to for the given from && to timestamp.

-

Optional uptime

uptime?: number
+

Optional uptime

uptime?: number

Use sli_value instead.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryResponse.html b/classes/v1.SLOHistoryResponse.html index d03eb1d3823..2dc4b290b73 100644 --- a/classes/v1.SLOHistoryResponse.html +++ b/classes/v1.SLOHistoryResponse.html @@ -1,5 +1,5 @@ SLOHistoryResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryResponse

A service level objective history response.

-

Hierarchy

  • SLOHistoryResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOHistoryResponseData

Optional errors

errors?: SLOHistoryResponseError[]
+

Hierarchy

  • SLOHistoryResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOHistoryResponseData

Optional errors

errors?: SLOHistoryResponseError[]

A list of errors while querying the history data for the service level objective.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryResponseData.html b/classes/v1.SLOHistoryResponseData.html index 0ff822f5ba7..05204ecee1c 100644 --- a/classes/v1.SLOHistoryResponseData.html +++ b/classes/v1.SLOHistoryResponseData.html @@ -1,15 +1,15 @@ SLOHistoryResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryResponseData

An array of service level objective objects.

-

Hierarchy

  • SLOHistoryResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fromTs

fromTs?: number
+

Hierarchy

  • SLOHistoryResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fromTs

fromTs?: number

The from timestamp in epoch seconds.

-

Optional groupBy

groupBy?: string[]
+

Optional groupBy

groupBy?: string[]

For metric based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. This is not included in responses for monitor based SLOs.

-

Optional groups

groups?: SLOHistoryMonitor[]
+

Optional groups

groups?: SLOHistoryMonitor[]

For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for metric based SLOs.

-

Optional monitors

monitors?: SLOHistoryMonitor[]
+

Optional monitors

monitors?: SLOHistoryMonitor[]

For multi-monitor SLOs, this represents SLI data for specific monitors. This is not included in the responses for metric based SLOs.

-

Optional overall

overall?: SLOHistorySLIData

Optional series

series?: SLOHistoryMetrics

Optional thresholds

thresholds?: {}
+

Optional overall

overall?: SLOHistorySLIData

Optional series

series?: SLOHistoryMetrics

Optional thresholds

thresholds?: {}

mapping of string timeframe to the SLO threshold.

-

Type declaration

Optional toTs

toTs?: number
+

Type declaration

Optional toTs

toTs?: number

The to timestamp in epoch seconds.

-

Optional type

type?: SLOType

Optional typeId

typeId?: SLOTypeNumeric

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: SLOType

Optional typeId

typeId?: SLOTypeNumeric

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryResponseError.html b/classes/v1.SLOHistoryResponseError.html index d2cab04b93d..9323bc4e9dc 100644 --- a/classes/v1.SLOHistoryResponseError.html +++ b/classes/v1.SLOHistoryResponseError.html @@ -1,5 +1,5 @@ SLOHistoryResponseError | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryResponseError

A list of errors while querying the history data for the service level objective.

-

Hierarchy

  • SLOHistoryResponseError

Index

Constructors

Properties

Constructors

constructor

Properties

Optional error

error?: string
+

Hierarchy

  • SLOHistoryResponseError

Index

Constructors

Properties

Constructors

constructor

Properties

Optional error

error?: string

Human readable error.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistoryResponseErrorWithType.html b/classes/v1.SLOHistoryResponseErrorWithType.html index fdde3d4c627..87cac420bbc 100644 --- a/classes/v1.SLOHistoryResponseErrorWithType.html +++ b/classes/v1.SLOHistoryResponseErrorWithType.html @@ -1,7 +1,7 @@ SLOHistoryResponseErrorWithType | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistoryResponseErrorWithType

An object describing the error with error type and error message.

-

Hierarchy

  • SLOHistoryResponseErrorWithType

Index

Constructors

Properties

Constructors

constructor

Properties

errorMessage

errorMessage: string
+

Hierarchy

  • SLOHistoryResponseErrorWithType

Index

Constructors

Properties

Constructors

constructor

Properties

errorMessage

errorMessage: string

A message with more details about the error.

-

errorType

errorType: string
+

errorType

errorType: string

Type of the error.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOHistorySLIData.html b/classes/v1.SLOHistorySLIData.html index 32aaae11ec7..59febf57d9c 100644 --- a/classes/v1.SLOHistorySLIData.html +++ b/classes/v1.SLOHistorySLIData.html @@ -1,27 +1,27 @@ SLOHistorySLIData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOHistorySLIData

An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

-

Hierarchy

  • SLOHistorySLIData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional errorBudgetRemaining

errorBudgetRemaining?: {}
+

Hierarchy

  • SLOHistorySLIData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional errorBudgetRemaining

errorBudgetRemaining?: {}

A mapping of threshold timeframe to the remaining error budget.

-

Type declaration

  • [key: string]: number

Optional errors

errors?: SLOHistoryResponseErrorWithType[]
+

Type declaration

  • [key: string]: number

Optional errors

errors?: SLOHistoryResponseErrorWithType[]

An array of error objects returned while querying the history data for the service level objective.

-

Optional group

group?: string
+

Optional group

group?: string

For groups in a grouped SLO, this is the group name.

-

Optional history

history?: number[][]
+

Optional history

history?: number[][]

For monitor based SLOs, this includes the aggregated history as arrays that include time series and uptime data where 0=monitor is in OK state and 1=monitor is in alert state.

-

Optional monitorModified

monitorModified?: number
+

Optional monitorModified

monitorModified?: number

For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

-

Optional monitorType

monitorType?: string
+

Optional monitorType

monitorType?: string

For monitor based SLOs, this describes the type of monitor.

-

Optional name

name?: string
+

Optional name

name?: string

For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.

-

Optional precision

precision?: {}
+

Optional precision

precision?: {}

A mapping of threshold timeframe to number of accurate decimals, regardless of the from && to timestamp.

-

Type declaration

  • [key: string]: number

Optional preview

preview?: boolean
+

Type declaration

  • [key: string]: number

Optional preview

preview?: boolean

For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime calculation.

-

Optional sliValue

sliValue?: number
+

Optional sliValue

sliValue?: number

The current SLI value of the SLO over the history window.

-

Optional spanPrecision

spanPrecision?: number
+

Optional spanPrecision

spanPrecision?: number

The amount of decimal places the SLI value is accurate to for the given from && to timestamp.

-

Optional uptime

uptime?: number
+

Optional uptime

uptime?: number

Use sli_value instead.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOListResponse.html b/classes/v1.SLOListResponse.html index 569533e80fa..d05a2baca83 100644 --- a/classes/v1.SLOListResponse.html +++ b/classes/v1.SLOListResponse.html @@ -1,7 +1,7 @@ SLOListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOListResponse

A response with one or more service level objective.

-

Hierarchy

  • SLOListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: ServiceLevelObjective[]
+

Hierarchy

  • SLOListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: ServiceLevelObjective[]

An array of service level objective objects.

-

Optional errors

errors?: string[]
+

Optional errors

errors?: string[]

An array of error messages. Each endpoint documents how/whether this field is used.

-

Optional metadata

metadata?: SLOListResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional metadata

metadata?: SLOListResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOListResponseMetadata.html b/classes/v1.SLOListResponseMetadata.html index 4cf7e068ee0..f3b7124faf1 100644 --- a/classes/v1.SLOListResponseMetadata.html +++ b/classes/v1.SLOListResponseMetadata.html @@ -1,3 +1,3 @@ SLOListResponseMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOListResponseMetadata

The metadata object containing additional information about the list of SLOs.

-

Hierarchy

  • SLOListResponseMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: SLOListResponseMetadataPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SLOListResponseMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: SLOListResponseMetadataPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOListResponseMetadataPage.html b/classes/v1.SLOListResponseMetadataPage.html index 4ca1adc0566..7da18c3aa03 100644 --- a/classes/v1.SLOListResponseMetadataPage.html +++ b/classes/v1.SLOListResponseMetadataPage.html @@ -1,7 +1,7 @@ SLOListResponseMetadataPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOListResponseMetadataPage

The object containing information about the pages of the list of SLOs.

-

Hierarchy

  • SLOListResponseMetadataPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number
+

Hierarchy

  • SLOListResponseMetadataPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number

The total number of resources that could be retrieved ignoring the parameters and filters in the request.

-

Optional totalFilteredCount

totalFilteredCount?: number
+

Optional totalFilteredCount

totalFilteredCount?: number

The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOResponse.html b/classes/v1.SLOResponse.html index c6b22674537..296640a2459 100644 --- a/classes/v1.SLOResponse.html +++ b/classes/v1.SLOResponse.html @@ -1,5 +1,5 @@ SLOResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOResponse

A service level objective response containing a single service level objective.

-

Hierarchy

  • SLOResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOResponseData

Optional errors

errors?: string[]
+

Hierarchy

  • SLOResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SLOResponseData

Optional errors

errors?: string[]

An array of error messages. Each endpoint documents how/whether this field is used.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOResponseData.html b/classes/v1.SLOResponseData.html index 20d441b73ac..844807dcffb 100644 --- a/classes/v1.SLOResponseData.html +++ b/classes/v1.SLOResponseData.html @@ -1,25 +1,25 @@ SLOResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOResponseData

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

-

Hierarchy

  • SLOResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional configuredAlertIds

configuredAlertIds?: number[]
+

Hierarchy

  • SLOResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional configuredAlertIds

configuredAlertIds?: number[]

A list of SLO monitors IDs that reference this SLO. This field is returned only when with_configured_alert_ids parameter is true in query.

-

Optional createdAt

createdAt?: number
+

Optional createdAt

createdAt?: number

Creation timestamp (UNIX time in seconds) Always included in service level objective responses.

-

Optional creator

creator?: v1.Creator

Optional description

description?: string
+

Optional creator

creator?: v1.Creator

Optional description

description?: string

A user-defined description of the service level objective. Always included in service level objective responses (but may be null). Optional in create/update requests.

-

Optional groups

groups?: string[]
+

Optional groups

groups?: string[]

A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the monitor_ids field is one.

-

Optional id

id?: string
+

Optional id

id?: string

A unique identifier for the service level objective object. Always included in service level objective responses.

-

Optional modifiedAt

modifiedAt?: number
+

Optional modifiedAt

modifiedAt?: number

Modification timestamp (UNIX time in seconds) Always included in service level objective responses.

-

Optional monitorIds

monitorIds?: number[]
+

Optional monitorIds

monitorIds?: number[]

A list of monitor ids that defines the scope of a monitor service level objective. Required if type is monitor.

-

Optional monitorTags

monitorTags?: string[]
+

Optional monitorTags

monitorTags?: string[]

The union of monitor tags for all monitors referenced by the monitor_ids field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the monitor_ids field).

-

Optional name

name?: string
+

Optional name

name?: string

The name of the service level objective object.

-

Optional query

query?: ServiceLevelObjectiveQuery

Optional tags

tags?: string[]
+

Optional query

query?: ServiceLevelObjectiveQuery

Optional tags

tags?: string[]

A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests.

-

Optional thresholds

thresholds?: SLOThreshold[]
+

Optional thresholds

thresholds?: SLOThreshold[]

The thresholds (timeframes and associated targets) for this service level objective object.

-

Optional type

type?: SLOType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: SLOType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOThreshold.html b/classes/v1.SLOThreshold.html index 9bf74f23df4..093ee184fb6 100644 --- a/classes/v1.SLOThreshold.html +++ b/classes/v1.SLOThreshold.html @@ -1,11 +1,11 @@ SLOThreshold | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOThreshold

SLO thresholds (target and optionally warning) for a single time window.

-

Hierarchy

  • SLOThreshold

Index

Constructors

Properties

Constructors

constructor

Properties

target

target: number
+

Hierarchy

  • SLOThreshold

Index

Constructors

Properties

Constructors

constructor

Properties

target

target: number

The target value for the service level indicator within the corresponding timeframe.

-

Optional targetDisplay

targetDisplay?: string
+

Optional targetDisplay

targetDisplay?: string

A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (for example 98.00). Always included in service level objective responses. Ignored in create/update requests.

-

timeframe

timeframe: SLOTimeframe

Optional warning

warning?: number
+

timeframe

timeframe: SLOTimeframe

Optional warning

warning?: number

The warning value for the service level objective.

-

Optional warningDisplay

warningDisplay?: string
+

Optional warningDisplay

warningDisplay?: string

A string representation of the warning target (see the description of the target_display field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SLOWidgetDefinition.html b/classes/v1.SLOWidgetDefinition.html index 1f7fb612568..fd35354b0e2 100644 --- a/classes/v1.SLOWidgetDefinition.html +++ b/classes/v1.SLOWidgetDefinition.html @@ -1,17 +1,17 @@ SLOWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SLOWidgetDefinition

Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.

-

Hierarchy

  • SLOWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional globalTimeTarget

globalTimeTarget?: string
+

Hierarchy

  • SLOWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional globalTimeTarget

globalTimeTarget?: string

Defined global time target.

-

Optional showErrorBudget

showErrorBudget?: boolean
+

Optional showErrorBudget

showErrorBudget?: boolean

Defined error budget.

-

Optional sloId

sloId?: string
+

Optional sloId

sloId?: string

ID of the SLO displayed.

-

Optional timeWindows

timeWindows?: WidgetTimeWindows[]
+

Optional timeWindows

timeWindows?: WidgetTimeWindows[]

Times being monitored.

-

Optional title

title?: string
+

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "slo"

Optional viewMode

viewMode?: WidgetViewMode

viewType

viewType: string
+

type

type: "slo"

Optional viewMode

viewMode?: WidgetViewMode

viewType

viewType: string

Type of view displayed by the widget.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ScatterPlotRequest.html b/classes/v1.ScatterPlotRequest.html index d5c23a6ede6..142fd759773 100644 --- a/classes/v1.ScatterPlotRequest.html +++ b/classes/v1.ScatterPlotRequest.html @@ -1,5 +1,5 @@ ScatterPlotRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScatterPlotRequest

Updated scatter plot.

-

Hierarchy

  • ScatterPlotRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: ScatterplotWidgetAggregator

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Hierarchy

  • ScatterPlotRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: ScatterplotWidgetAggregator

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Query definition.

-

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ScatterPlotWidgetDefinition.html b/classes/v1.ScatterPlotWidgetDefinition.html index b52b5821eb6..cb5bb269c69 100644 --- a/classes/v1.ScatterPlotWidgetDefinition.html +++ b/classes/v1.ScatterPlotWidgetDefinition.html @@ -1,11 +1,11 @@ ScatterPlotWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScatterPlotWidgetDefinition

The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation.

-

Hierarchy

  • ScatterPlotWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional colorByGroups

colorByGroups?: string[]
+

Hierarchy

  • ScatterPlotWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional colorByGroups

colorByGroups?: string[]

List of groups used for colors.

-

Optional customLinks

customLinks?: WidgetCustomLink[]
+

Optional customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

-

requests

requests: ScatterPlotWidgetDefinitionRequests

Optional time

time?: WidgetTime

Optional title

title?: string
+

requests

requests: ScatterPlotWidgetDefinitionRequests

Optional time

time?: WidgetTime

Optional title

title?: string

Title of your widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "scatterplot"

Optional xaxis

xaxis?: WidgetAxis

Optional yaxis

yaxis?: WidgetAxis

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "scatterplot"

Optional xaxis

xaxis?: WidgetAxis

Optional yaxis

yaxis?: WidgetAxis

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ScatterPlotWidgetDefinitionRequests.html b/classes/v1.ScatterPlotWidgetDefinitionRequests.html index 7821e34cc51..422d44e8d1d 100644 --- a/classes/v1.ScatterPlotWidgetDefinitionRequests.html +++ b/classes/v1.ScatterPlotWidgetDefinitionRequests.html @@ -1,3 +1,3 @@ ScatterPlotWidgetDefinitionRequests | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScatterPlotWidgetDefinitionRequests

Widget definition.

-

Hierarchy

  • ScatterPlotWidgetDefinitionRequests

Index

Constructors

Properties

Constructors

constructor

Properties

Optional table

table?: ScatterplotTableRequest

Optional x

x?: ScatterPlotRequest

Optional y

y?: ScatterPlotRequest

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ScatterPlotWidgetDefinitionRequests

Index

Constructors

Properties

Constructors

constructor

Properties

Optional table

table?: ScatterplotTableRequest

Optional x

x?: ScatterPlotRequest

Optional y

y?: ScatterPlotRequest

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ScatterplotTableRequest.html b/classes/v1.ScatterplotTableRequest.html index db2267703ee..bb2232e28c7 100644 --- a/classes/v1.ScatterplotTableRequest.html +++ b/classes/v1.ScatterplotTableRequest.html @@ -1,7 +1,7 @@ ScatterplotTableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScatterplotTableRequest

Scatterplot request containing formulas and functions.

-

Hierarchy

  • ScatterplotTableRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional formulas

formulas?: ScatterplotWidgetFormula[]
+

Hierarchy

  • ScatterplotTableRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional formulas

formulas?: ScatterplotWidgetFormula[]

List of Scatterplot formulas that operate on queries. This feature is currently in beta.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ScatterplotWidgetFormula.html b/classes/v1.ScatterplotWidgetFormula.html index ccdec68416e..2f75398ecff 100644 --- a/classes/v1.ScatterplotWidgetFormula.html +++ b/classes/v1.ScatterplotWidgetFormula.html @@ -1,7 +1,7 @@ ScatterplotWidgetFormula | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScatterplotWidgetFormula

Formula to be used in a Scatterplot widget query.

-

Hierarchy

  • ScatterplotWidgetFormula

Index

Constructors

Properties

Constructors

constructor

Properties

Optional alias

alias?: string
+

Hierarchy

  • ScatterplotWidgetFormula

Index

Constructors

Properties

Constructors

constructor

Properties

Optional alias

alias?: string

Expression alias.

-

dimension

dimension: ScatterplotDimension

formula

formula: string
+

dimension

dimension: ScatterplotDimension

formula

formula: string

String expression built from queries, formulas, and functions.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SelfDecodingBody.html b/classes/v1.SelfDecodingBody.html index beb4ec04a79..c3fa8b228ed 100644 --- a/classes/v1.SelfDecodingBody.html +++ b/classes/v1.SelfDecodingBody.html @@ -1,3 +1,3 @@ SelfDecodingBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SelfDecodingBody

Helper class to generate a ResponseBody from binary data

-

Hierarchy

  • SelfDecodingBody

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SelfDecodingBody

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Series.html b/classes/v1.Series.html index 966c94fabd0..47bf1c2a1fc 100644 --- a/classes/v1.Series.html +++ b/classes/v1.Series.html @@ -1,15 +1,15 @@ Series | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Series

A metric to submit to Datadog. See Datadog metrics.

-

Hierarchy

  • Series

Index

Constructors

Properties

Constructors

constructor

Properties

Optional host

host?: string
+

Hierarchy

  • Series

Index

Constructors

Properties

Constructors

constructor

Properties

Optional host

host?: string

The name of the host that produced the metric.

-

Optional interval

interval?: number
+

Optional interval

interval?: number

If the type of the metric is rate or count, define the corresponding interval.

-

metric

metric: string
+

metric

metric: string

The name of the timeseries.

-

points

points: number[][]
+

points

points: number[][]

Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

A list of tags associated with the metric.

-

Optional type

type?: string
+

Optional type

type?: string

The type of the metric either count, gauge, or rate.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ServerConfiguration.html b/classes/v1.ServerConfiguration.html index 4c5251b0578..a0dd9a92824 100644 --- a/classes/v1.ServerConfiguration.html +++ b/classes/v1.ServerConfiguration.html @@ -1,14 +1,14 @@ ServerConfiguration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerConfiguration<T>

Represents the configuration of a server including its url template and variable configuration based on the url.

-

Type parameters

  • T: {}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getConfiguration

  • getConfiguration(): {}

makeRequestContext

Type parameters

  • T: {}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getConfiguration

  • getConfiguration(): {}

makeRequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

Returns v1.RequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

listSLOCorrection

updateSLOCorrection

updateSLOCorrection

type

type: SLOType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ServiceLevelObjectivesApi.html b/classes/v1.ServiceLevelObjectivesApi.html index 8638de077cd..10117efe8b6 100644 --- a/classes/v1.ServiceLevelObjectivesApi.html +++ b/classes/v1.ServiceLevelObjectivesApi.html @@ -1,36 +1,36 @@ -ServiceLevelObjectivesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceLevelObjectivesApi

Hierarchy

  • ServiceLevelObjectivesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ServiceLevelObjectivesApi(configuration: v1.Configuration, requestFactory?: ServiceLevelObjectivesApiRequestFactory, responseProcessor?: ServiceLevelObjectivesApiResponseProcessor): ServiceLevelObjectivesApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: ServiceLevelObjectivesApiRequestFactory

Private responseProcessor

responseProcessor: ServiceLevelObjectivesApiResponseProcessor

Methods

checkCanDeleteSLO

createSLO

deleteSLO

Returns Promise<SLOListResponse>

deleteSLO

deleteSLOTimeframeInBulk

Returns Promise<SLODeleteResponse>

deleteSLOTimeframeInBulk

getSLO

Returns Promise<SLOBulkDeleteResponse>

getSLO

getSLOCorrections

Returns Promise<SLOResponse>

getSLOCorrections

getSLOHistory

Returns Promise<SLOCorrectionListResponse>

getSLOHistory

listSLOs

Returns Promise<SLOHistoryResponse>

listSLOs

updateSLO

Returns Promise<SLOListResponse>

updateSLO

type

type: "servicemap"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ServiceSummaryWidgetDefinition.html b/classes/v1.ServiceSummaryWidgetDefinition.html index f12a94d4c9d..7edeca7fd07 100644 --- a/classes/v1.ServiceSummaryWidgetDefinition.html +++ b/classes/v1.ServiceSummaryWidgetDefinition.html @@ -1,25 +1,25 @@ ServiceSummaryWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceSummaryWidgetDefinition

The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.

-

Hierarchy

  • ServiceSummaryWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional displayFormat

displayFormat?: WidgetServiceSummaryDisplayFormat

env

env: string
+

Hierarchy

  • ServiceSummaryWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional displayFormat

displayFormat?: WidgetServiceSummaryDisplayFormat

env

env: string

APM environment.

-

service

service: string
+

service

service: string

APM service.

-

Optional showBreakdown

showBreakdown?: boolean
+

Optional showBreakdown

showBreakdown?: boolean

Whether to show the latency breakdown or not.

-

Optional showDistribution

showDistribution?: boolean
+

Optional showDistribution

showDistribution?: boolean

Whether to show the latency distribution or not.

-

Optional showErrors

showErrors?: boolean
+

Optional showErrors

showErrors?: boolean

Whether to show the error metrics or not.

-

Optional showHits

showHits?: boolean
+

Optional showHits

showHits?: boolean

Whether to show the hits metrics or not.

-

Optional showLatency

showLatency?: boolean
+

Optional showLatency

showLatency?: boolean

Whether to show the latency metrics or not.

-

Optional showResourceList

showResourceList?: boolean
+

Optional showResourceList

showResourceList?: boolean

Whether to show the resource list or not.

-

Optional sizeFormat

sizeFormat?: WidgetSizeFormat

spanName

spanName: string
+

Optional sizeFormat

sizeFormat?: WidgetSizeFormat

spanName

spanName: string

APM span name.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "trace_service"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "trace_service"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SlackIntegrationApi.html b/classes/v1.SlackIntegrationApi.html index 09b81b556e5..76d1b7c1e0d 100644 --- a/classes/v1.SlackIntegrationApi.html +++ b/classes/v1.SlackIntegrationApi.html @@ -1,20 +1,20 @@ -SlackIntegrationApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SlackIntegrationApi

Hierarchy

  • SlackIntegrationApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SlackIntegrationApi(configuration: v1.Configuration, requestFactory?: SlackIntegrationApiRequestFactory, responseProcessor?: SlackIntegrationApiResponseProcessor): SlackIntegrationApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: SlackIntegrationApiRequestFactory

Private responseProcessor

responseProcessor: SlackIntegrationApiResponseProcessor

Methods

createSlackIntegrationChannel

getSlackIntegrationChannel

getSlackIntegrationChannels

Returns Promise<SlackIntegrationChannel>

getSlackIntegrationChannels

removeSlackIntegrationChannel

Returns Promise<SlackIntegrationChannel[]>

removeSlackIntegrationChannel

updateSlackIntegrationChannel

Returns Promise<void>

updateSlackIntegrationChannel

Hierarchy

  • SunburstWidgetLegendTable

Index

Constructors

Properties

Constructors

constructor

Properties

type

type: SunburstWidgetLegendTableType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SunburstWidgetRequest.html b/classes/v1.SunburstWidgetRequest.html index 06e33231659..5cae820d945 100644 --- a/classes/v1.SunburstWidgetRequest.html +++ b/classes/v1.SunburstWidgetRequest.html @@ -1,9 +1,9 @@ SunburstWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SunburstWidgetRequest

Request definition of sunburst widget.

-

Hierarchy

  • SunburstWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]
+

Hierarchy

  • SunburstWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Widget query.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPIStep.html b/classes/v1.SyntheticsAPIStep.html index 0b09080c103..df6ebfa9af8 100644 --- a/classes/v1.SyntheticsAPIStep.html +++ b/classes/v1.SyntheticsAPIStep.html @@ -1,13 +1,13 @@ SyntheticsAPIStep | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPIStep

The steps used in a Synthetics multistep API test.

-

Hierarchy

  • SyntheticsAPIStep

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowFailure

allowFailure?: boolean
+

Hierarchy

  • SyntheticsAPIStep

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowFailure

allowFailure?: boolean

Determines whether or not to continue with test if this step fails.

-

assertions

assertions: SyntheticsAssertion[]
+

assertions

assertions: SyntheticsAssertion[]

Array of assertions used for the test.

-

Optional extractedValues

extractedValues?: SyntheticsParsingOptions[]
+

Optional extractedValues

extractedValues?: SyntheticsParsingOptions[]

Array of values to parse and save as variables from the response.

-

Optional isCritical

isCritical?: boolean
+

Optional isCritical

isCritical?: boolean

Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allowFailure is true.

-

name

name: string
+

name

name: string

The name of the step.

-

request

request: SyntheticsTestRequest

Optional retry

retry?: SyntheticsTestOptionsRetry

subtype

subtype: "http"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

request

request: SyntheticsTestRequest

Optional retry

retry?: SyntheticsTestOptionsRetry

subtype

subtype: "http"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITest.html b/classes/v1.SyntheticsAPITest.html index 097ac2395ca..06d1b2f3d5d 100644 --- a/classes/v1.SyntheticsAPITest.html +++ b/classes/v1.SyntheticsAPITest.html @@ -1,15 +1,15 @@ SyntheticsAPITest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITest

Object containing details about a Synthetic API test.

-

Hierarchy

  • SyntheticsAPITest

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsAPITestConfig

locations

locations: string[]
+

Hierarchy

  • SyntheticsAPITest

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsAPITestConfig

locations

locations: string[]

Array of locations used to run the test.

-

Optional message

message?: string
+

Optional message

message?: string

Notification message associated with the test.

-

Optional monitorId

monitorId?: number
+

Optional monitorId

monitorId?: number

The associated monitor ID.

-

name

name: string
+

name

name: string

Name of the test.

-

options

options: SyntheticsTestOptions

Optional publicId

publicId?: string
+

options

options: SyntheticsTestOptions

Optional publicId

publicId?: string

The public ID for the test.

-

Optional status

status?: SyntheticsTestPauseStatus

Optional subtype

subtype?: SyntheticsTestDetailsSubType

Optional tags

tags?: string[]
+

Optional status

status?: SyntheticsTestPauseStatus

Optional subtype

subtype?: SyntheticsTestDetailsSubType

Optional tags

tags?: string[]

Array of tags attached to the test.

-

type

type: "api"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "api"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITestConfig.html b/classes/v1.SyntheticsAPITestConfig.html index ef699ce234c..a1092acd445 100644 --- a/classes/v1.SyntheticsAPITestConfig.html +++ b/classes/v1.SyntheticsAPITestConfig.html @@ -1,9 +1,9 @@ SyntheticsAPITestConfig | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITestConfig

Configuration object for a Synthetic API test.

-

Hierarchy

  • SyntheticsAPITestConfig

Index

Constructors

Properties

Constructors

constructor

Properties

Optional assertions

assertions?: SyntheticsAssertion[]
+

Hierarchy

  • SyntheticsAPITestConfig

Index

Constructors

Properties

Constructors

constructor

Properties

Optional assertions

assertions?: SyntheticsAssertion[]

Array of assertions used for the test. Required for single API tests.

-

Optional configVariables

configVariables?: SyntheticsConfigVariable[]
+

Optional configVariables

configVariables?: SyntheticsConfigVariable[]

Array of variables used for the test.

-

Optional request

request?: SyntheticsTestRequest

Optional steps

steps?: SyntheticsAPIStep[]
+

Optional request

request?: SyntheticsTestRequest

Optional steps

steps?: SyntheticsAPIStep[]

When the test subtype is multi, the steps of the test.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITestResultData.html b/classes/v1.SyntheticsAPITestResultData.html index 1be2e93295c..6c3c8e01036 100644 --- a/classes/v1.SyntheticsAPITestResultData.html +++ b/classes/v1.SyntheticsAPITestResultData.html @@ -1,13 +1,13 @@ SyntheticsAPITestResultData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITestResultData

Object containing results for your Synthetic API test.

-

Hierarchy

  • SyntheticsAPITestResultData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cert

cert?: SyntheticsSSLCertificate

Optional eventType

eventType?: SyntheticsTestProcessStatus

Optional failure

failure?: SyntheticsApiTestResultFailure

Optional httpStatusCode

httpStatusCode?: number
+

Hierarchy

  • SyntheticsAPITestResultData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cert

cert?: SyntheticsSSLCertificate

Optional eventType

eventType?: SyntheticsTestProcessStatus

Optional failure

failure?: SyntheticsApiTestResultFailure

Optional httpStatusCode

httpStatusCode?: number

The API test HTTP status code.

-

Optional requestHeaders

requestHeaders?: {}
+

Optional requestHeaders

requestHeaders?: {}

Request header object used for the API test.

-

Type declaration

  • [key: string]: any

Optional responseBody

responseBody?: string
+

Type declaration

  • [key: string]: any

Optional responseBody

responseBody?: string

Response body returned for the API test.

-

Optional responseHeaders

responseHeaders?: {}
+

Optional responseHeaders

responseHeaders?: {}

Response headers returned for the API test.

-

Type declaration

  • [key: string]: any

Optional responseSize

responseSize?: number
+

Type declaration

  • [key: string]: any

Optional responseSize

responseSize?: number

Global size in byte of the API test response.

-

Optional timings

timings?: SyntheticsTiming

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional timings

timings?: SyntheticsTiming

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITestResultFull.html b/classes/v1.SyntheticsAPITestResultFull.html index 79d70dfc931..04c98a44fc5 100644 --- a/classes/v1.SyntheticsAPITestResultFull.html +++ b/classes/v1.SyntheticsAPITestResultFull.html @@ -1,11 +1,11 @@ SyntheticsAPITestResultFull | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITestResultFull

Object returned describing a API test result.

-

Hierarchy

  • SyntheticsAPITestResultFull

Index

Constructors

Properties

Constructors

constructor

Properties

Optional check

check?: SyntheticsAPITestResultFullCheck

Optional checkTime

checkTime?: number
+

Hierarchy

  • SyntheticsAPITestResultFull

Index

Constructors

Properties

Constructors

constructor

Properties

Optional check

check?: SyntheticsAPITestResultFullCheck

Optional checkTime

checkTime?: number

When the API test was conducted.

-

Optional checkVersion

checkVersion?: number
+

Optional checkVersion

checkVersion?: number

Version of the API test used.

-

Optional probeDc

probeDc?: string
+

Optional probeDc

probeDc?: string

Locations for which to query the API test results.

-

Optional result

result?: SyntheticsAPITestResultData

Optional resultId

resultId?: string
+

Optional result

result?: SyntheticsAPITestResultData

Optional resultId

resultId?: string

ID of the API test result.

-

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITestResultFullCheck.html b/classes/v1.SyntheticsAPITestResultFullCheck.html index 99f7e420b5c..01420607872 100644 --- a/classes/v1.SyntheticsAPITestResultFullCheck.html +++ b/classes/v1.SyntheticsAPITestResultFullCheck.html @@ -1,3 +1,3 @@ SyntheticsAPITestResultFullCheck | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITestResultFullCheck

Object describing the API test configuration.

-

Hierarchy

  • SyntheticsAPITestResultFullCheck

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsTestConfig

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsAPITestResultFullCheck

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsTestConfig

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITestResultShort.html b/classes/v1.SyntheticsAPITestResultShort.html index a5493549ee8..970d4384397 100644 --- a/classes/v1.SyntheticsAPITestResultShort.html +++ b/classes/v1.SyntheticsAPITestResultShort.html @@ -1,9 +1,9 @@ SyntheticsAPITestResultShort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITestResultShort

Object with the results of a single Synthetic API test.

-

Hierarchy

  • SyntheticsAPITestResultShort

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkTime

checkTime?: number
+

Hierarchy

  • SyntheticsAPITestResultShort

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkTime

checkTime?: number

Last time the API test was performed.

-

Optional probeDc

probeDc?: string
+

Optional probeDc

probeDc?: string

Location from which the API test was performed.

-

Optional result

result?: SyntheticsAPITestResultShortResult

Optional resultId

resultId?: string
+

Optional result

result?: SyntheticsAPITestResultShortResult

Optional resultId

resultId?: string

ID of the API test result.

-

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAPITestResultShortResult.html b/classes/v1.SyntheticsAPITestResultShortResult.html index 70ab9d839eb..438d85ef930 100644 --- a/classes/v1.SyntheticsAPITestResultShortResult.html +++ b/classes/v1.SyntheticsAPITestResultShortResult.html @@ -1,5 +1,5 @@ SyntheticsAPITestResultShortResult | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAPITestResultShortResult

Result of the last API test run.

-

Hierarchy

  • SyntheticsAPITestResultShortResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional passed

passed?: boolean
+

Hierarchy

  • SyntheticsAPITestResultShortResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional passed

passed?: boolean

Describes if the test run has passed or failed.

-

Optional timings

timings?: SyntheticsTiming

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional timings

timings?: SyntheticsTiming

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsApi.html b/classes/v1.SyntheticsApi.html index 37b88f167b3..983ee741174 100644 --- a/classes/v1.SyntheticsApi.html +++ b/classes/v1.SyntheticsApi.html @@ -1,102 +1,102 @@ -SyntheticsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsApi

Hierarchy

  • SyntheticsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SyntheticsApi(configuration: v1.Configuration, requestFactory?: SyntheticsApiRequestFactory, responseProcessor?: SyntheticsApiResponseProcessor): SyntheticsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: SyntheticsApiRequestFactory

Private responseProcessor

responseProcessor: SyntheticsApiResponseProcessor

Methods

createGlobalVariable

createPrivateLocation

createSyntheticsAPITest

Returns Promise<SyntheticsPrivateLocationCreationResponse>

createSyntheticsAPITest

createSyntheticsBrowserTest

Returns Promise<SyntheticsAPITest>

createSyntheticsBrowserTest

deleteGlobalVariable

Returns Promise<SyntheticsBrowserTest>

deleteGlobalVariable

deletePrivateLocation

Returns Promise<void>

deletePrivateLocation

deleteTests

Returns Promise<void>

deleteTests

editGlobalVariable

Returns Promise<SyntheticsDeleteTestsResponse>

editGlobalVariable

getAPITest

Returns Promise<SyntheticsGlobalVariable>

getAPITest

getAPITestLatestResults

Returns Promise<SyntheticsAPITest>

getAPITestLatestResults

getAPITestResult

Returns Promise<SyntheticsGetAPITestLatestResultsResponse>

getAPITestResult

getBrowserTest

Returns Promise<SyntheticsAPITestResultFull>

getBrowserTest

getBrowserTestLatestResults

Returns Promise<SyntheticsBrowserTest>

getBrowserTestLatestResults

getBrowserTestResult

Returns Promise<SyntheticsGetBrowserTestLatestResultsResponse>

getBrowserTestResult

getGlobalVariable

Returns Promise<SyntheticsBrowserTestResultFull>

getGlobalVariable

getPrivateLocation

Returns Promise<SyntheticsGlobalVariable>

getPrivateLocation

getSyntheticsCIBatch

Returns Promise<SyntheticsPrivateLocation>

getSyntheticsCIBatch

getTest

Returns Promise<SyntheticsBatchDetails>

getTest

listGlobalVariables

Returns Promise<SyntheticsTestDetails>

listGlobalVariables

listLocations

listLocations

listTests

listTests

triggerCITests

triggerCITests

triggerTests

Returns Promise<SyntheticsTriggerCITestsResponse>

triggerTests

updateAPITest

Returns Promise<SyntheticsTriggerCITestsResponse>

updateAPITest

updateBrowserTest

Returns Promise<SyntheticsAPITest>

updateBrowserTest

updatePrivateLocation

Returns Promise<SyntheticsBrowserTest>

updatePrivateLocation

updateTestPauseStatus

Returns Promise<SyntheticsPrivateLocation>

updateTestPauseStatus

Optional target

target?: SyntheticsAssertionJSONPathTargetTarget

type

type: SyntheticsAssertionType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAssertionJSONPathTargetTarget.html b/classes/v1.SyntheticsAssertionJSONPathTargetTarget.html index 46a9f0aa39b..d70144fb107 100644 --- a/classes/v1.SyntheticsAssertionJSONPathTargetTarget.html +++ b/classes/v1.SyntheticsAssertionJSONPathTargetTarget.html @@ -1,9 +1,9 @@ SyntheticsAssertionJSONPathTargetTarget | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAssertionJSONPathTargetTarget

Composed target for validatesJSONPath operator.

-

Hierarchy

  • SyntheticsAssertionJSONPathTargetTarget

Index

Constructors

Properties

Constructors

constructor

Properties

Optional jsonPath

jsonPath?: string
+

Hierarchy

  • SyntheticsAssertionJSONPathTargetTarget

Index

Constructors

Properties

Constructors

constructor

Properties

Optional jsonPath

jsonPath?: string

The JSON path to assert.

-

Optional operator

operator?: string
+

Optional operator

operator?: string

The specific operator to use on the path.

-

Optional targetValue

targetValue?: any
+

Optional targetValue

targetValue?: any

The path target value to compare to.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsAssertionTarget.html b/classes/v1.SyntheticsAssertionTarget.html index 27508a8d9fb..ef058523a72 100644 --- a/classes/v1.SyntheticsAssertionTarget.html +++ b/classes/v1.SyntheticsAssertionTarget.html @@ -1,7 +1,7 @@ SyntheticsAssertionTarget | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsAssertionTarget

An assertion which uses a simple target.

-

Hierarchy

  • SyntheticsAssertionTarget

Index

Constructors

Properties

Constructors

constructor

Properties

operator

operator: SyntheticsAssertionOperator

Optional property

property?: string
+

Hierarchy

  • SyntheticsAssertionTarget

Index

Constructors

Properties

Constructors

constructor

Properties

operator

operator: SyntheticsAssertionOperator

Optional property

property?: string

The associated assertion property.

-

target

target: any
+

target

target: any

Value used by the operator.

-

type

type: SyntheticsAssertionType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: SyntheticsAssertionType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBasicAuthNTLM.html b/classes/v1.SyntheticsBasicAuthNTLM.html index 8f436ae6ec1..59668b543e7 100644 --- a/classes/v1.SyntheticsBasicAuthNTLM.html +++ b/classes/v1.SyntheticsBasicAuthNTLM.html @@ -1,11 +1,11 @@ SyntheticsBasicAuthNTLM | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBasicAuthNTLM

Object to handle NTLM authentication when performing the test.

-

Hierarchy

  • SyntheticsBasicAuthNTLM

Index

Constructors

Properties

Constructors

constructor

Properties

Optional domain

domain?: string
+

Hierarchy

  • SyntheticsBasicAuthNTLM

Index

Constructors

Properties

Constructors

constructor

Properties

Optional domain

domain?: string

Domain for the authentication to use when performing the test.

-

Optional password

password?: string
+

Optional password

password?: string

Password for the authentication to use when performing the test.

-

type

type: "ntlm"

Optional username

username?: string
+

type

type: "ntlm"

Optional username

username?: string

Username for the authentication to use when performing the test.

-

Optional workstation

workstation?: string
+

Optional workstation

workstation?: string

Workstation for the authentication to use when performing the test.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBasicAuthSigv4.html b/classes/v1.SyntheticsBasicAuthSigv4.html index 58764f8e3ec..fe2bc90fb8e 100644 --- a/classes/v1.SyntheticsBasicAuthSigv4.html +++ b/classes/v1.SyntheticsBasicAuthSigv4.html @@ -1,13 +1,13 @@ SyntheticsBasicAuthSigv4 | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBasicAuthSigv4

Object to handle SIGV4 authentication when performing the test.

-

Hierarchy

  • SyntheticsBasicAuthSigv4

Index

Constructors

Properties

Constructors

constructor

Properties

accessKey

accessKey: string
+

Hierarchy

  • SyntheticsBasicAuthSigv4

Index

Constructors

Properties

Constructors

constructor

Properties

accessKey

accessKey: string

Access key for the SIGV4 authentication.

-

Optional region

region?: string
+

Optional region

region?: string

Region for the SIGV4 authentication.

-

secretKey

secretKey: string
+

secretKey

secretKey: string

Secret key for the SIGV4 authentication.

-

Optional serviceName

serviceName?: string
+

Optional serviceName

serviceName?: string

Service name for the SIGV4 authentication.

-

Optional sessionToken

sessionToken?: string
+

Optional sessionToken

sessionToken?: string

Session token for the SIGV4 authentication.

-

type

type: "sigv4"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "sigv4"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBasicAuthWeb.html b/classes/v1.SyntheticsBasicAuthWeb.html index 4e420fd03cf..7d3a54929f9 100644 --- a/classes/v1.SyntheticsBasicAuthWeb.html +++ b/classes/v1.SyntheticsBasicAuthWeb.html @@ -1,7 +1,7 @@ SyntheticsBasicAuthWeb | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBasicAuthWeb

Object to handle basic authentication when performing the test.

-

Hierarchy

  • SyntheticsBasicAuthWeb

Index

Constructors

Properties

Constructors

constructor

Properties

password

password: string
+

Hierarchy

  • SyntheticsBasicAuthWeb

Index

Constructors

Properties

Constructors

constructor

Properties

password

password: string

Password to use for the basic authentication.

-

type

type: "web"

username

username: string
+

type

type: "web"

username

username: string

Username to use for the basic authentication.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBatchDetails.html b/classes/v1.SyntheticsBatchDetails.html index 382f35f670c..5a802e68c73 100644 --- a/classes/v1.SyntheticsBatchDetails.html +++ b/classes/v1.SyntheticsBatchDetails.html @@ -1,3 +1,3 @@ SyntheticsBatchDetails | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBatchDetails

Details about a batch response.

-

Hierarchy

  • SyntheticsBatchDetails

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SyntheticsBatchDetailsData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsBatchDetails

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SyntheticsBatchDetailsData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBatchDetailsData.html b/classes/v1.SyntheticsBatchDetailsData.html index 7039802767a..b713a5c904c 100644 --- a/classes/v1.SyntheticsBatchDetailsData.html +++ b/classes/v1.SyntheticsBatchDetailsData.html @@ -1,5 +1,5 @@ SyntheticsBatchDetailsData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBatchDetailsData

Wrapper object that contains the details of a batch.

-

Hierarchy

  • SyntheticsBatchDetailsData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: SyntheticsCIBatchMetadata

Optional results

results?: SyntheticsBatchResult[]
+

Hierarchy

  • SyntheticsBatchDetailsData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: SyntheticsCIBatchMetadata

Optional results

results?: SyntheticsBatchResult[]

List of results for the batch.

-

Optional status

status?: SyntheticsStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: SyntheticsStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBatchResult.html b/classes/v1.SyntheticsBatchResult.html index 2a859ae3c18..3ad42cc4152 100644 --- a/classes/v1.SyntheticsBatchResult.html +++ b/classes/v1.SyntheticsBatchResult.html @@ -1,15 +1,15 @@ SyntheticsBatchResult | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBatchResult

Object with the results of a Synthetics batch.

-

Hierarchy

  • SyntheticsBatchResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional device

device?: SyntheticsDeviceID

Optional duration

duration?: number
+

Hierarchy

  • SyntheticsBatchResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional device

device?: SyntheticsDeviceID

Optional duration

duration?: number

Total duration in millisecond of the test.

-

Optional executionRule

executionRule?: SyntheticsTestExecutionRule

Optional location

location?: string
+

Optional executionRule

executionRule?: SyntheticsTestExecutionRule

Optional location

location?: string

Name of the location.

-

Optional resultId

resultId?: string
+

Optional resultId

resultId?: string

The ID of the result to get.

-

Optional retries

retries?: number
+

Optional retries

retries?: number

Total duration in millisecond of the test.

-

Optional status

status?: SyntheticsStatus

Optional testName

testName?: string
+

Optional status

status?: SyntheticsStatus

Optional testName

testName?: string

Name of the test.

-

Optional testPublicId

testPublicId?: string
+

Optional testPublicId

testPublicId?: string

The public ID of the Synthetic test.

-

Optional testType

testType?: SyntheticsTestDetailsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional testType

testType?: SyntheticsTestDetailsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserError.html b/classes/v1.SyntheticsBrowserError.html index 50e09f0f575..386fc15721c 100644 --- a/classes/v1.SyntheticsBrowserError.html +++ b/classes/v1.SyntheticsBrowserError.html @@ -1,9 +1,9 @@ SyntheticsBrowserError | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserError

Error response object for a browser test.

-

Hierarchy

  • SyntheticsBrowserError

Index

Constructors

Properties

Constructors

constructor

Properties

description

description: string
+

Hierarchy

  • SyntheticsBrowserError

Index

Constructors

Properties

Constructors

constructor

Properties

description

description: string

Description of the error.

-

name

name: string
+

name

name: string

Name of the error.

-

Optional status

status?: number
+

Optional status

status?: number

Status Code of the error.

-

type

type: SyntheticsBrowserErrorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: SyntheticsBrowserErrorType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTest.html b/classes/v1.SyntheticsBrowserTest.html index fcb467bbac5..7b3b94c585d 100644 --- a/classes/v1.SyntheticsBrowserTest.html +++ b/classes/v1.SyntheticsBrowserTest.html @@ -1,17 +1,17 @@ SyntheticsBrowserTest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTest

Object containing details about a Synthetic browser test.

-

Hierarchy

  • SyntheticsBrowserTest

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsBrowserTestConfig

locations

locations: string[]
+

Hierarchy

  • SyntheticsBrowserTest

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsBrowserTestConfig

locations

locations: string[]

Array of locations used to run the test.

-

Optional message

message?: string
+

Optional message

message?: string

Notification message associated with the test. Message can either be text or an empty string.

-

Optional monitorId

monitorId?: number
+

Optional monitorId

monitorId?: number

The associated monitor ID.

-

name

name: string
+

name

name: string

Name of the test.

-

options

options: SyntheticsTestOptions

Optional publicId

publicId?: string
+

options

options: SyntheticsTestOptions

Optional publicId

publicId?: string

The public ID of the test.

-

Optional status

status?: SyntheticsTestPauseStatus

Optional steps

steps?: SyntheticsStep[]
+

Optional status

status?: SyntheticsTestPauseStatus

Optional steps

steps?: SyntheticsStep[]

The steps of the test.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

Array of tags attached to the test.

-

type

type: "browser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "browser"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestConfig.html b/classes/v1.SyntheticsBrowserTestConfig.html index 56ea922026c..befa4c81154 100644 --- a/classes/v1.SyntheticsBrowserTestConfig.html +++ b/classes/v1.SyntheticsBrowserTestConfig.html @@ -1,11 +1,11 @@ SyntheticsBrowserTestConfig | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestConfig

Configuration object for a Synthetic browser test.

-

Hierarchy

  • SyntheticsBrowserTestConfig

Index

Constructors

Properties

Constructors

constructor

Properties

assertions

assertions: SyntheticsAssertion[]
+

Hierarchy

  • SyntheticsBrowserTestConfig

Index

Constructors

Properties

Constructors

constructor

Properties

assertions

assertions: SyntheticsAssertion[]

Array of assertions used for the test.

-

Optional configVariables

configVariables?: SyntheticsConfigVariable[]
+

Optional configVariables

configVariables?: SyntheticsConfigVariable[]

Array of variables used for the test.

-

request

request: SyntheticsTestRequest

Optional setCookie

setCookie?: string
+

request

request: SyntheticsTestRequest

Optional setCookie

setCookie?: string

Cookies to be used for the request, using the Set-Cookie syntax.

-

Optional variables

variables?: SyntheticsBrowserVariable[]
+

Optional variables

variables?: SyntheticsBrowserVariable[]

Array of variables used for the test steps.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestResultData.html b/classes/v1.SyntheticsBrowserTestResultData.html index 88abbfcb6dc..f9e318c5657 100644 --- a/classes/v1.SyntheticsBrowserTestResultData.html +++ b/classes/v1.SyntheticsBrowserTestResultData.html @@ -1,23 +1,23 @@ SyntheticsBrowserTestResultData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestResultData

Object containing results for your Synthetic browser test.

-

Hierarchy

  • SyntheticsBrowserTestResultData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional browserType

browserType?: string
+

Hierarchy

  • SyntheticsBrowserTestResultData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional browserType

browserType?: string

Type of browser device used for the browser test.

-

Optional browserVersion

browserVersion?: string
+

Optional browserVersion

browserVersion?: string

Browser version used for the browser test.

-

Optional device

device?: SyntheticsDevice

Optional duration

duration?: number
+

Optional device

device?: SyntheticsDevice

Optional duration

duration?: number

Global duration in second of the browser test.

-

Optional error

error?: string
+

Optional error

error?: string

Error returned for the browser test.

-

Optional failure

failure?: SyntheticsBrowserTestResultFailure

Optional passed

passed?: boolean
+

Optional failure

failure?: SyntheticsBrowserTestResultFailure

Optional passed

passed?: boolean

Whether or not the browser test was conducted.

-

Optional receivedEmailCount

receivedEmailCount?: number
+

Optional receivedEmailCount

receivedEmailCount?: number

The amount of email received during the browser test.

-

Optional startUrl

startUrl?: string
+

Optional startUrl

startUrl?: string

Starting URL for the browser test.

-

Optional stepDetails

stepDetails?: SyntheticsStepDetail[]
+

Optional stepDetails

stepDetails?: SyntheticsStepDetail[]

Array containing the different browser test steps.

-

Optional thumbnailsBucketKey

thumbnailsBucketKey?: boolean
+

Optional thumbnailsBucketKey

thumbnailsBucketKey?: boolean

Whether or not a thumbnail is associated with the browser test.

-

Optional timeToInteractive

timeToInteractive?: number
+

Optional timeToInteractive

timeToInteractive?: number

Time in second to wait before the browser test starts after reaching the start URL.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestResultFailure.html b/classes/v1.SyntheticsBrowserTestResultFailure.html index 694cf17d2ad..584f65b1f9d 100644 --- a/classes/v1.SyntheticsBrowserTestResultFailure.html +++ b/classes/v1.SyntheticsBrowserTestResultFailure.html @@ -1,5 +1,5 @@ SyntheticsBrowserTestResultFailure | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestResultFailure

The browser test failure details.

-

Hierarchy

  • SyntheticsBrowserTestResultFailure

Index

Constructors

Properties

Constructors

constructor

Properties

Optional code

code?: SyntheticsBrowserTestFailureCode

Optional message

message?: string
+

Hierarchy

  • SyntheticsBrowserTestResultFailure

Index

Constructors

Properties

Constructors

constructor

Properties

Optional code

code?: SyntheticsBrowserTestFailureCode

Optional message

message?: string

The browser test error message.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestResultFull.html b/classes/v1.SyntheticsBrowserTestResultFull.html index e56a590aca8..23a2d7ded0f 100644 --- a/classes/v1.SyntheticsBrowserTestResultFull.html +++ b/classes/v1.SyntheticsBrowserTestResultFull.html @@ -1,11 +1,11 @@ SyntheticsBrowserTestResultFull | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestResultFull

Object returned describing a browser test result.

-

Hierarchy

  • SyntheticsBrowserTestResultFull

Index

Constructors

Properties

Constructors

constructor

Properties

Optional check

check?: SyntheticsBrowserTestResultFullCheck

Optional checkTime

checkTime?: number
+

Hierarchy

  • SyntheticsBrowserTestResultFull

Index

Constructors

Properties

Constructors

constructor

Properties

Optional check

check?: SyntheticsBrowserTestResultFullCheck

Optional checkTime

checkTime?: number

When the browser test was conducted.

-

Optional checkVersion

checkVersion?: number
+

Optional checkVersion

checkVersion?: number

Version of the browser test used.

-

Optional probeDc

probeDc?: string
+

Optional probeDc

probeDc?: string

Location from which the browser test was performed.

-

Optional result

result?: SyntheticsBrowserTestResultData

Optional resultId

resultId?: string
+

Optional result

result?: SyntheticsBrowserTestResultData

Optional resultId

resultId?: string

ID of the browser test result.

-

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestResultFullCheck.html b/classes/v1.SyntheticsBrowserTestResultFullCheck.html index 443eaf83257..4054996eeaa 100644 --- a/classes/v1.SyntheticsBrowserTestResultFullCheck.html +++ b/classes/v1.SyntheticsBrowserTestResultFullCheck.html @@ -1,3 +1,3 @@ SyntheticsBrowserTestResultFullCheck | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestResultFullCheck

Object describing the browser test configuration.

-

Hierarchy

  • SyntheticsBrowserTestResultFullCheck

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsTestConfig

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsBrowserTestResultFullCheck

Index

Constructors

Properties

Constructors

constructor

Properties

config

config: SyntheticsTestConfig

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestResultShort.html b/classes/v1.SyntheticsBrowserTestResultShort.html index 0021bd696c8..9154a6bc920 100644 --- a/classes/v1.SyntheticsBrowserTestResultShort.html +++ b/classes/v1.SyntheticsBrowserTestResultShort.html @@ -1,9 +1,9 @@ SyntheticsBrowserTestResultShort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestResultShort

Object with the results of a single Synthetic browser test.

-

Hierarchy

  • SyntheticsBrowserTestResultShort

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkTime

checkTime?: number
+

Hierarchy

  • SyntheticsBrowserTestResultShort

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkTime

checkTime?: number

Last time the browser test was performed.

-

Optional probeDc

probeDc?: string
+

Optional probeDc

probeDc?: string

Location from which the Browser test was performed.

-

Optional result

result?: SyntheticsBrowserTestResultShortResult

Optional resultId

resultId?: string
+

Optional result

result?: SyntheticsBrowserTestResultShortResult

Optional resultId

resultId?: string

ID of the browser test result.

-

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: SyntheticsTestMonitorStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserTestResultShortResult.html b/classes/v1.SyntheticsBrowserTestResultShortResult.html index d313eb5cef0..e861ab5e774 100644 --- a/classes/v1.SyntheticsBrowserTestResultShortResult.html +++ b/classes/v1.SyntheticsBrowserTestResultShortResult.html @@ -1,11 +1,11 @@ SyntheticsBrowserTestResultShortResult | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserTestResultShortResult

Object with the result of the last browser test run.

-

Hierarchy

  • SyntheticsBrowserTestResultShortResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional device

device?: SyntheticsDevice

Optional duration

duration?: number
+

Hierarchy

  • SyntheticsBrowserTestResultShortResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional device

device?: SyntheticsDevice

Optional duration

duration?: number

Length in milliseconds of the browser test run.

-

Optional errorCount

errorCount?: number
+

Optional errorCount

errorCount?: number

Amount of errors collected for a single browser test run.

-

Optional stepCountCompleted

stepCountCompleted?: number
+

Optional stepCountCompleted

stepCountCompleted?: number

Amount of browser test steps completed before failing.

-

Optional stepCountTotal

stepCountTotal?: number
+

Optional stepCountTotal

stepCountTotal?: number

Total amount of browser test steps.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsBrowserVariable.html b/classes/v1.SyntheticsBrowserVariable.html index fc33143953e..09825167620 100644 --- a/classes/v1.SyntheticsBrowserVariable.html +++ b/classes/v1.SyntheticsBrowserVariable.html @@ -1,11 +1,11 @@ SyntheticsBrowserVariable | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsBrowserVariable

Object defining a variable that can be used in your browser test. Learn more in the Browser test Actions documentation.

-

Hierarchy

  • SyntheticsBrowserVariable

Index

Constructors

Properties

Constructors

constructor

Properties

Optional example

example?: string
+

Hierarchy

  • SyntheticsBrowserVariable

Index

Constructors

Properties

Constructors

constructor

Properties

Optional example

example?: string

Example for the variable.

-

Optional id

id?: string
+

Optional id

id?: string

ID for the variable. Global variables require an ID.

-

name

name: string
+

name

name: string

Name of the variable.

-

Optional pattern

pattern?: string
+

Optional pattern

pattern?: string

Pattern of the variable.

-

type

type: SyntheticsBrowserVariableType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: SyntheticsBrowserVariableType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCIBatchMetadata.html b/classes/v1.SyntheticsCIBatchMetadata.html index c21596255d5..9484f7dbfe1 100644 --- a/classes/v1.SyntheticsCIBatchMetadata.html +++ b/classes/v1.SyntheticsCIBatchMetadata.html @@ -1,3 +1,3 @@ SyntheticsCIBatchMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCIBatchMetadata

Metadata for the Synthetics tests run.

-

Hierarchy

  • SyntheticsCIBatchMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ci

ci?: SyntheticsCIBatchMetadataCI

Optional git

git?: SyntheticsCIBatchMetadataGit

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsCIBatchMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ci

ci?: SyntheticsCIBatchMetadataCI

Optional git

git?: SyntheticsCIBatchMetadataGit

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCIBatchMetadataCI.html b/classes/v1.SyntheticsCIBatchMetadataCI.html index e14a6b29cf1..f7951fd9ebb 100644 --- a/classes/v1.SyntheticsCIBatchMetadataCI.html +++ b/classes/v1.SyntheticsCIBatchMetadataCI.html @@ -1,3 +1,3 @@ SyntheticsCIBatchMetadataCI | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCIBatchMetadataCI

Description of the CI provider.

-

Hierarchy

  • SyntheticsCIBatchMetadataCI

Index

Constructors

Properties

Constructors

constructor

Properties

Optional pipeline

pipeline?: SyntheticsCIBatchMetadataPipeline

Optional provider

provider?: SyntheticsCIBatchMetadataProvider

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsCIBatchMetadataCI

Index

Constructors

Properties

Constructors

constructor

Properties

Optional pipeline

pipeline?: SyntheticsCIBatchMetadataPipeline

Optional provider

provider?: SyntheticsCIBatchMetadataProvider

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCIBatchMetadataGit.html b/classes/v1.SyntheticsCIBatchMetadataGit.html index 3000dbb0564..46c790073a8 100644 --- a/classes/v1.SyntheticsCIBatchMetadataGit.html +++ b/classes/v1.SyntheticsCIBatchMetadataGit.html @@ -1,7 +1,7 @@ SyntheticsCIBatchMetadataGit | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCIBatchMetadataGit

Git information.

-

Hierarchy

  • SyntheticsCIBatchMetadataGit

Index

Constructors

Properties

Constructors

constructor

Properties

Optional branch

branch?: string
+

Hierarchy

  • SyntheticsCIBatchMetadataGit

Index

Constructors

Properties

Constructors

constructor

Properties

Optional branch

branch?: string

Branch name.

-

Optional commitSha

commitSha?: string
+

Optional commitSha

commitSha?: string

The commit SHA.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCIBatchMetadataPipeline.html b/classes/v1.SyntheticsCIBatchMetadataPipeline.html index 984fab77c58..7b98d6544e0 100644 --- a/classes/v1.SyntheticsCIBatchMetadataPipeline.html +++ b/classes/v1.SyntheticsCIBatchMetadataPipeline.html @@ -1,5 +1,5 @@ SyntheticsCIBatchMetadataPipeline | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCIBatchMetadataPipeline

Description of the CI pipeline.

-

Hierarchy

  • SyntheticsCIBatchMetadataPipeline

Index

Constructors

Properties

Constructors

constructor

Properties

Optional url

url?: string
+

Hierarchy

  • SyntheticsCIBatchMetadataPipeline

Index

Constructors

Properties

Constructors

constructor

Properties

Optional url

url?: string

URL of the pipeline.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCIBatchMetadataProvider.html b/classes/v1.SyntheticsCIBatchMetadataProvider.html index d3e7deaaa7a..173e448e6ef 100644 --- a/classes/v1.SyntheticsCIBatchMetadataProvider.html +++ b/classes/v1.SyntheticsCIBatchMetadataProvider.html @@ -1,5 +1,5 @@ SyntheticsCIBatchMetadataProvider | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCIBatchMetadataProvider

Description of the CI provider.

-

Hierarchy

  • SyntheticsCIBatchMetadataProvider

Index

Constructors

Properties

Constructors

constructor

Properties

Optional name

name?: string
+

Hierarchy

  • SyntheticsCIBatchMetadataProvider

Index

Constructors

Properties

Constructors

constructor

Properties

Optional name

name?: string

Name of the CI provider.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCITest.html b/classes/v1.SyntheticsCITest.html index abac2198dce..6f6c45f0ce7 100644 --- a/classes/v1.SyntheticsCITest.html +++ b/classes/v1.SyntheticsCITest.html @@ -1,25 +1,25 @@ SyntheticsCITest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCITest

Test configuration for Synthetics CI

-

Hierarchy

  • SyntheticsCITest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowInsecureCertificates

allowInsecureCertificates?: boolean
+

Hierarchy

  • SyntheticsCITest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowInsecureCertificates

allowInsecureCertificates?: boolean

Disable certificate checks in API tests.

-

Optional basicAuth

basicAuth?: SyntheticsBasicAuth

Optional body

body?: string
+

Optional basicAuth

basicAuth?: SyntheticsBasicAuth

Optional body

body?: string

Body to include in the test.

-

Optional bodyType

bodyType?: string
+

Optional bodyType

bodyType?: string

Type of the data sent in a synthetics API test.

-

Optional cookies

cookies?: string
+

Optional cookies

cookies?: string

Cookies for the request.

-

Optional deviceIds

deviceIds?: SyntheticsDeviceID[]
+

Optional deviceIds

deviceIds?: SyntheticsDeviceID[]

For browser test, array with the different device IDs used to run the test.

-

Optional followRedirects

followRedirects?: boolean
+

Optional followRedirects

followRedirects?: boolean

For API HTTP test, whether or not the test should follow redirects.

-

Optional headers

headers?: {}
+

Optional headers

headers?: {}

Headers to include when performing the test.

-

Type declaration

  • [key: string]: string

Optional locations

locations?: string[]
+

Type declaration

  • [key: string]: string

Optional locations

locations?: string[]

Array of locations used to run the test.

-

Optional metadata

metadata?: SyntheticsCIBatchMetadata

publicId

publicId: string
+

Optional metadata

metadata?: SyntheticsCIBatchMetadata

publicId

publicId: string

The public ID of the Synthetics test to trigger.

-

Optional retry

retry?: SyntheticsTestOptionsRetry

Optional startUrl

startUrl?: string
+

Optional retry

retry?: SyntheticsTestOptionsRetry

Optional startUrl

startUrl?: string

Starting URL for the browser test.

-

Optional variables

variables?: {}
+

Optional variables

variables?: {}

Variables to replace in the test.

Type declaration

  • [key: string]: string

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCITestBody.html b/classes/v1.SyntheticsCITestBody.html index 7f46ce9efe5..e3c1eac4311 100644 --- a/classes/v1.SyntheticsCITestBody.html +++ b/classes/v1.SyntheticsCITestBody.html @@ -1,5 +1,5 @@ SyntheticsCITestBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCITestBody

Object describing the synthetics tests to trigger.

-

Hierarchy

  • SyntheticsCITestBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tests

tests?: SyntheticsCITest[]
+

Hierarchy

  • SyntheticsCITestBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tests

tests?: SyntheticsCITest[]

Individual synthetics test.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsConfigVariable.html b/classes/v1.SyntheticsConfigVariable.html index d5d4df5e459..5d0c35f2718 100644 --- a/classes/v1.SyntheticsConfigVariable.html +++ b/classes/v1.SyntheticsConfigVariable.html @@ -1,11 +1,11 @@ SyntheticsConfigVariable | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsConfigVariable

Object defining a variable that can be used in your test configuration.

-

Hierarchy

  • SyntheticsConfigVariable

Index

Constructors

Properties

Constructors

constructor

Properties

Optional example

example?: string
+

Hierarchy

  • SyntheticsConfigVariable

Index

Constructors

Properties

Constructors

constructor

Properties

Optional example

example?: string

Example for the variable.

-

Optional id

id?: string
+

Optional id

id?: string

ID of the variable for global variables.

-

name

name: string
+

name

name: string

Name of the variable.

-

Optional pattern

pattern?: string
+

Optional pattern

pattern?: string

Pattern of the variable.

-

type

type: SyntheticsConfigVariableType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: SyntheticsConfigVariableType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsCoreWebVitals.html b/classes/v1.SyntheticsCoreWebVitals.html index d9c939da25d..2b440bc9b18 100644 --- a/classes/v1.SyntheticsCoreWebVitals.html +++ b/classes/v1.SyntheticsCoreWebVitals.html @@ -1,9 +1,9 @@ SyntheticsCoreWebVitals | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsCoreWebVitals

Core Web Vitals attached to a browser test step.

-

Hierarchy

  • SyntheticsCoreWebVitals

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cls

cls?: number
+

Hierarchy

  • SyntheticsCoreWebVitals

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cls

cls?: number

Cumulative Layout Shift.

-

Optional lcp

lcp?: number
+

Optional lcp

lcp?: number

Largest Contentful Paint in milliseconds.

-

Optional url

url?: string
+

Optional url

url?: string

URL attached to the metrics.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsDeleteTestsPayload.html b/classes/v1.SyntheticsDeleteTestsPayload.html index 6ae7b231d8e..f6606e85fb5 100644 --- a/classes/v1.SyntheticsDeleteTestsPayload.html +++ b/classes/v1.SyntheticsDeleteTestsPayload.html @@ -1,5 +1,5 @@ SyntheticsDeleteTestsPayload | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsDeleteTestsPayload

A JSON list of the ID or IDs of the Synthetic tests that you want to delete.

-

Hierarchy

  • SyntheticsDeleteTestsPayload

Index

Constructors

Properties

Constructors

constructor

Properties

Optional publicIds

publicIds?: string[]
+

Hierarchy

  • SyntheticsDeleteTestsPayload

Index

Constructors

Properties

Constructors

constructor

Properties

Optional publicIds

publicIds?: string[]

An array of Synthetic test IDs you want to delete.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsDeleteTestsResponse.html b/classes/v1.SyntheticsDeleteTestsResponse.html index 8311766ca47..9d72ff09826 100644 --- a/classes/v1.SyntheticsDeleteTestsResponse.html +++ b/classes/v1.SyntheticsDeleteTestsResponse.html @@ -1,5 +1,5 @@ SyntheticsDeleteTestsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsDeleteTestsResponse

Response object for deleting Synthetic tests.

-

Hierarchy

  • SyntheticsDeleteTestsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedTests

deletedTests?: SyntheticsDeletedTest[]
+

Hierarchy

  • SyntheticsDeleteTestsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedTests

deletedTests?: SyntheticsDeletedTest[]

Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsDeletedTest.html b/classes/v1.SyntheticsDeletedTest.html index c2b05c1e161..4ebedbdbcfe 100644 --- a/classes/v1.SyntheticsDeletedTest.html +++ b/classes/v1.SyntheticsDeletedTest.html @@ -1,7 +1,7 @@ SyntheticsDeletedTest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsDeletedTest

Object containing a deleted Synthetic test ID with the associated deletion timestamp.

-

Hierarchy

  • SyntheticsDeletedTest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedAt

deletedAt?: Date
+

Hierarchy

  • SyntheticsDeletedTest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional deletedAt

deletedAt?: Date

Deletion timestamp of the Synthetic test ID.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The Synthetic test ID deleted.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsDevice.html b/classes/v1.SyntheticsDevice.html index d838bbfaa49..e260dd5078f 100644 --- a/classes/v1.SyntheticsDevice.html +++ b/classes/v1.SyntheticsDevice.html @@ -1,11 +1,11 @@ SyntheticsDevice | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsDevice

Object describing the device used to perform the Synthetic test.

-

Hierarchy

  • SyntheticsDevice

Index

Constructors

Properties

Constructors

constructor

Properties

height

height: number
+

Hierarchy

  • SyntheticsDevice

Index

Constructors

Properties

Constructors

constructor

Properties

height

height: number

Screen height of the device.

-

id

id: SyntheticsDeviceID

Optional isMobile

isMobile?: boolean
+

id

id: SyntheticsDeviceID

Optional isMobile

isMobile?: boolean

Whether or not the device is a mobile.

-

name

name: string
+

name

name: string

The device name.

-

width

width: number
+

width

width: number

Screen width of the device.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsGetAPITestLatestResultsResponse.html b/classes/v1.SyntheticsGetAPITestLatestResultsResponse.html index 6f912e3fcc8..1e66782dfee 100644 --- a/classes/v1.SyntheticsGetAPITestLatestResultsResponse.html +++ b/classes/v1.SyntheticsGetAPITestLatestResultsResponse.html @@ -1,7 +1,7 @@ SyntheticsGetAPITestLatestResultsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsGetAPITestLatestResultsResponse

Object with the latest Synthetic API test run.

-

Hierarchy

  • SyntheticsGetAPITestLatestResultsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lastTimestampFetched

lastTimestampFetched?: number
+

Hierarchy

  • SyntheticsGetAPITestLatestResultsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lastTimestampFetched

lastTimestampFetched?: number

Timestamp of the latest API test run.

-

Optional results

results?: SyntheticsAPITestResultShort[]
+

Optional results

results?: SyntheticsAPITestResultShort[]

Result of the latest API test run.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsGetBrowserTestLatestResultsResponse.html b/classes/v1.SyntheticsGetBrowserTestLatestResultsResponse.html index e176e3a00d7..d629741acc3 100644 --- a/classes/v1.SyntheticsGetBrowserTestLatestResultsResponse.html +++ b/classes/v1.SyntheticsGetBrowserTestLatestResultsResponse.html @@ -1,7 +1,7 @@ SyntheticsGetBrowserTestLatestResultsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsGetBrowserTestLatestResultsResponse

Object with the latest Synthetic browser test run.

-

Hierarchy

  • SyntheticsGetBrowserTestLatestResultsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lastTimestampFetched

lastTimestampFetched?: number
+

Hierarchy

  • SyntheticsGetBrowserTestLatestResultsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lastTimestampFetched

lastTimestampFetched?: number

Timestamp of the latest browser test run.

-

Optional results

results?: SyntheticsBrowserTestResultShort[]
+

Optional results

results?: SyntheticsBrowserTestResultShort[]

Result of the latest browser test run.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsGlobalVariable.html b/classes/v1.SyntheticsGlobalVariable.html index e826ee917ea..a49eeaf8a76 100644 --- a/classes/v1.SyntheticsGlobalVariable.html +++ b/classes/v1.SyntheticsGlobalVariable.html @@ -1,13 +1,13 @@ SyntheticsGlobalVariable | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsGlobalVariable

Synthetics global variable.

-

Hierarchy

  • SyntheticsGlobalVariable

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SyntheticsGlobalVariableAttributes

description

description: string
+

Hierarchy

  • SyntheticsGlobalVariable

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SyntheticsGlobalVariableAttributes

description

description: string

Description of the global variable.

-

Optional id

id?: string
+

Optional id

id?: string

Unique identifier of the global variable.

-

name

name: string
+

name

name: string

Name of the global variable. Unique across Synthetics global variables.

-

Optional parseTestOptions

parseTestOptions?: SyntheticsGlobalVariableParseTestOptions

Optional parseTestPublicId

parseTestPublicId?: string
+

Optional parseTestOptions

parseTestOptions?: SyntheticsGlobalVariableParseTestOptions

Optional parseTestPublicId

parseTestPublicId?: string

A Synthetic test ID to use as a test to generate the variable value.

-

tags

tags: string[]
+

tags

tags: string[]

Tags of the global variable.

-

value

value: SyntheticsGlobalVariableValue

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

value

value: SyntheticsGlobalVariableValue

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsGlobalVariableAttributes.html b/classes/v1.SyntheticsGlobalVariableAttributes.html index 2a824ae1306..41a65576b1c 100644 --- a/classes/v1.SyntheticsGlobalVariableAttributes.html +++ b/classes/v1.SyntheticsGlobalVariableAttributes.html @@ -1,5 +1,5 @@ SyntheticsGlobalVariableAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsGlobalVariableAttributes

Attributes of the global variable.

-

Hierarchy

  • SyntheticsGlobalVariableAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional restrictedRoles

restrictedRoles?: string[]
+

Hierarchy

  • SyntheticsGlobalVariableAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional restrictedRoles

restrictedRoles?: string[]

List of role identifiers that can be pulled from the Roles API.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsGlobalVariableParseTestOptions.html b/classes/v1.SyntheticsGlobalVariableParseTestOptions.html index 5e4ed7b9dac..e67f2c0a9f1 100644 --- a/classes/v1.SyntheticsGlobalVariableParseTestOptions.html +++ b/classes/v1.SyntheticsGlobalVariableParseTestOptions.html @@ -1,5 +1,5 @@ SyntheticsGlobalVariableParseTestOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsGlobalVariableParseTestOptions

Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with parse_test_public_id.

-

Hierarchy

  • SyntheticsGlobalVariableParseTestOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional field

field?: string
+

Hierarchy

  • SyntheticsGlobalVariableParseTestOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional field

field?: string

When type is http_header, name of the header to use to extract the value.

-

parser

parser: SyntheticsVariableParser

type

type: SyntheticsGlobalVariableParseTestOptionsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

parser

parser: SyntheticsVariableParser

type

type: SyntheticsGlobalVariableParseTestOptionsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsGlobalVariableValue.html b/classes/v1.SyntheticsGlobalVariableValue.html index 6a014f1a4d6..b7a9c20cff6 100644 --- a/classes/v1.SyntheticsGlobalVariableValue.html +++ b/classes/v1.SyntheticsGlobalVariableValue.html @@ -1,7 +1,7 @@ SyntheticsGlobalVariableValue | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsGlobalVariableValue

Value of the global variable.

-

Hierarchy

  • SyntheticsGlobalVariableValue

Index

Constructors

Properties

Constructors

constructor

Properties

Optional secure

secure?: boolean
+

Hierarchy

  • SyntheticsGlobalVariableValue

Index

Constructors

Properties

Constructors

constructor

Properties

Optional secure

secure?: boolean

Determines if the value of the variable is hidden.

-

Optional value

value?: string
+

Optional value

value?: string

Value of the global variable. When reading a global variable, the value will not be present if the variable is hidden with the secure property.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsListGlobalVariablesResponse.html b/classes/v1.SyntheticsListGlobalVariablesResponse.html index b4d6e9e39db..86215490363 100644 --- a/classes/v1.SyntheticsListGlobalVariablesResponse.html +++ b/classes/v1.SyntheticsListGlobalVariablesResponse.html @@ -1,5 +1,5 @@ SyntheticsListGlobalVariablesResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsListGlobalVariablesResponse

Object containing an array of Synthetic global variables.

-

Hierarchy

  • SyntheticsListGlobalVariablesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional variables

variables?: SyntheticsGlobalVariable[]
+

Hierarchy

  • SyntheticsListGlobalVariablesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional variables

variables?: SyntheticsGlobalVariable[]

Array of Synthetic global variables.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsListTestsResponse.html b/classes/v1.SyntheticsListTestsResponse.html index e4146d3c96e..c49b54b2cf3 100644 --- a/classes/v1.SyntheticsListTestsResponse.html +++ b/classes/v1.SyntheticsListTestsResponse.html @@ -1,5 +1,5 @@ SyntheticsListTestsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsListTestsResponse

Object containing an array of Synthetic tests configuration.

-

Hierarchy

  • SyntheticsListTestsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tests

tests?: SyntheticsTestDetails[]
+

Hierarchy

  • SyntheticsListTestsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tests

tests?: SyntheticsTestDetails[]

Array of Synthetic tests configuration.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsLocation.html b/classes/v1.SyntheticsLocation.html index e3ee1952585..f31eecf8a2f 100644 --- a/classes/v1.SyntheticsLocation.html +++ b/classes/v1.SyntheticsLocation.html @@ -1,7 +1,7 @@ SyntheticsLocation | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsLocation

Synthetic location that can be used when creating or editing a test.

-

Hierarchy

  • SyntheticsLocation

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string
+

Hierarchy

  • SyntheticsLocation

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string

Unique identifier of the location.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the location.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsLocations.html b/classes/v1.SyntheticsLocations.html index ca1a809a710..f0c9acc4fc7 100644 --- a/classes/v1.SyntheticsLocations.html +++ b/classes/v1.SyntheticsLocations.html @@ -1,5 +1,5 @@ SyntheticsLocations | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsLocations

List of Synthetics locations.

-

Hierarchy

  • SyntheticsLocations

Index

Constructors

Properties

Constructors

constructor

Properties

Optional locations

locations?: SyntheticsLocation[]
+

Hierarchy

  • SyntheticsLocations

Index

Constructors

Properties

Constructors

constructor

Properties

Optional locations

locations?: SyntheticsLocation[]

List of Synthetics locations.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsParsingOptions.html b/classes/v1.SyntheticsParsingOptions.html index d7ea88286b3..3bdf76b6444 100644 --- a/classes/v1.SyntheticsParsingOptions.html +++ b/classes/v1.SyntheticsParsingOptions.html @@ -1,7 +1,7 @@ SyntheticsParsingOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsParsingOptions

Parsing options for variables to extract.

-

Hierarchy

  • SyntheticsParsingOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional field

field?: string
+

Hierarchy

  • SyntheticsParsingOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional field

field?: string

When type is http_header, name of the header to use to extract the value.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the variable to extract.

-

Optional parser

parser?: SyntheticsVariableParser

Optional type

type?: SyntheticsGlobalVariableParseTestOptionsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional parser

parser?: SyntheticsVariableParser

Optional type

type?: SyntheticsGlobalVariableParseTestOptionsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsPrivateLocation.html b/classes/v1.SyntheticsPrivateLocation.html index b5c903d728d..5f2a721366c 100644 --- a/classes/v1.SyntheticsPrivateLocation.html +++ b/classes/v1.SyntheticsPrivateLocation.html @@ -1,11 +1,11 @@ SyntheticsPrivateLocation | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsPrivateLocation

Object containing information about the private location to create.

-

Hierarchy

  • SyntheticsPrivateLocation

Index

Constructors

Properties

Constructors

constructor

Properties

description

description: string
+

Hierarchy

  • SyntheticsPrivateLocation

Index

Constructors

Properties

Constructors

constructor

Properties

description

description: string

Description of the private location.

-

Optional id

id?: string
+

Optional id

id?: string

Unique identifier of the private location.

-

name

name: string
+

name

name: string

Name of the private location.

-

Optional secrets

secrets?: SyntheticsPrivateLocationSecrets

tags

tags: string[]
+

Optional secrets

secrets?: SyntheticsPrivateLocationSecrets

tags

tags: string[]

Array of tags attached to the private location.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsPrivateLocationCreationResponse.html b/classes/v1.SyntheticsPrivateLocationCreationResponse.html index 3aaee46ff2a..73765d5ba6c 100644 --- a/classes/v1.SyntheticsPrivateLocationCreationResponse.html +++ b/classes/v1.SyntheticsPrivateLocationCreationResponse.html @@ -1,5 +1,5 @@ SyntheticsPrivateLocationCreationResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsPrivateLocationCreationResponse

Object that contains the new private location, the public key for result encryption, and the configuration skeleton.

-

Hierarchy

  • SyntheticsPrivateLocationCreationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional config

config?: any
+

Hierarchy

  • SyntheticsPrivateLocationCreationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional config

config?: any

Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.

-

Optional privateLocation

privateLocation?: SyntheticsPrivateLocation

Optional resultEncryption

resultEncryption?: SyntheticsPrivateLocationCreationResponseResultEncryption

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional privateLocation

privateLocation?: SyntheticsPrivateLocation

Optional resultEncryption

resultEncryption?: SyntheticsPrivateLocationCreationResponseResultEncryption

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsPrivateLocationCreationResponseResultEncryption.html b/classes/v1.SyntheticsPrivateLocationCreationResponseResultEncryption.html index cb2a72f3618..9d2adb7f75c 100644 --- a/classes/v1.SyntheticsPrivateLocationCreationResponseResultEncryption.html +++ b/classes/v1.SyntheticsPrivateLocationCreationResponseResultEncryption.html @@ -1,7 +1,7 @@ SyntheticsPrivateLocationCreationResponseResultEncryption | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsPrivateLocationCreationResponseResultEncryption

Public key for the result encryption.

-

Hierarchy

  • SyntheticsPrivateLocationCreationResponseResultEncryption

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string
+

Hierarchy

  • SyntheticsPrivateLocationCreationResponseResultEncryption

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string

Fingerprint for the encryption key.

-

Optional key

key?: string
+

Optional key

key?: string

Public key for result encryption.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsPrivateLocationSecrets.html b/classes/v1.SyntheticsPrivateLocationSecrets.html index f08730698a2..c911ec17b9c 100644 --- a/classes/v1.SyntheticsPrivateLocationSecrets.html +++ b/classes/v1.SyntheticsPrivateLocationSecrets.html @@ -1,3 +1,3 @@ SyntheticsPrivateLocationSecrets | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsPrivateLocationSecrets

Secrets for the private location. Only present in the response when creating the private location.

-

Hierarchy

  • SyntheticsPrivateLocationSecrets

Index

Constructors

Properties

Constructors

constructor

Properties

Optional authentication

authentication?: SyntheticsPrivateLocationSecretsAuthentication

Optional configDecryption

configDecryption?: SyntheticsPrivateLocationSecretsConfigDecryption

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsPrivateLocationSecrets

Index

Constructors

Properties

Constructors

constructor

Properties

Optional authentication

authentication?: SyntheticsPrivateLocationSecretsAuthentication

Optional configDecryption

configDecryption?: SyntheticsPrivateLocationSecretsConfigDecryption

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsPrivateLocationSecretsAuthentication.html b/classes/v1.SyntheticsPrivateLocationSecretsAuthentication.html index 445f0846a83..bd311f3a9c9 100644 --- a/classes/v1.SyntheticsPrivateLocationSecretsAuthentication.html +++ b/classes/v1.SyntheticsPrivateLocationSecretsAuthentication.html @@ -1,7 +1,7 @@ SyntheticsPrivateLocationSecretsAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsPrivateLocationSecretsAuthentication

Authentication part of the secrets.

-

Hierarchy

  • SyntheticsPrivateLocationSecretsAuthentication

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string
+

Hierarchy

  • SyntheticsPrivateLocationSecretsAuthentication

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string

Access key for the private location.

-

Optional key

key?: string
+

Optional key

key?: string

Secret access key for the private location.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsPrivateLocationSecretsConfigDecryption.html b/classes/v1.SyntheticsPrivateLocationSecretsConfigDecryption.html index 489a3b3f2c5..dc279004e5b 100644 --- a/classes/v1.SyntheticsPrivateLocationSecretsConfigDecryption.html +++ b/classes/v1.SyntheticsPrivateLocationSecretsConfigDecryption.html @@ -1,5 +1,5 @@ SyntheticsPrivateLocationSecretsConfigDecryption | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsPrivateLocationSecretsConfigDecryption

Private key for the private location.

-

Hierarchy

  • SyntheticsPrivateLocationSecretsConfigDecryption

Index

Constructors

Properties

Constructors

constructor

Properties

Optional key

key?: string
+

Hierarchy

  • SyntheticsPrivateLocationSecretsConfigDecryption

Index

Constructors

Properties

Constructors

constructor

Properties

Optional key

key?: string

Private key for the private location.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsSSLCertificate.html b/classes/v1.SyntheticsSSLCertificate.html index fd984ea3550..89f80a30847 100644 --- a/classes/v1.SyntheticsSSLCertificate.html +++ b/classes/v1.SyntheticsSSLCertificate.html @@ -1,23 +1,23 @@ SyntheticsSSLCertificate | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsSSLCertificate

Object describing the SSL certificate used for a Synthetic test.

-

Hierarchy

  • SyntheticsSSLCertificate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cipher

cipher?: string
+

Hierarchy

  • SyntheticsSSLCertificate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cipher

cipher?: string

Cipher used for the connection.

-

Optional exponent

exponent?: number
+

Optional exponent

exponent?: number

Exponent associated to the certificate.

-

Optional extKeyUsage

extKeyUsage?: string[]
+

Optional extKeyUsage

extKeyUsage?: string[]

Array of extensions and details used for the certificate.

-

Optional fingerprint

fingerprint?: string
+

Optional fingerprint

fingerprint?: string

MD5 digest of the DER-encoded Certificate information.

-

Optional fingerprint256

fingerprint256?: string
+

Optional fingerprint256

fingerprint256?: string

SHA-1 digest of the DER-encoded Certificate information.

-

Optional issuer

issuer?: SyntheticsSSLCertificateIssuer

Optional modulus

modulus?: string
+

Optional issuer

issuer?: SyntheticsSSLCertificateIssuer

Optional modulus

modulus?: string

Modulus associated to the SSL certificate private key.

-

Optional protocol

protocol?: string
+

Optional protocol

protocol?: string

TLS protocol used for the test.

-

Optional serialNumber

serialNumber?: string
+

Optional serialNumber

serialNumber?: string

Serial Number assigned by Symantec to the SSL certificate.

-

Optional subject

subject?: SyntheticsSSLCertificateSubject

Optional validFrom

validFrom?: Date
+

Optional subject

subject?: SyntheticsSSLCertificateSubject

Optional validFrom

validFrom?: Date

Date from which the SSL certificate is valid.

-

Optional validTo

validTo?: Date
+

Optional validTo

validTo?: Date

Date until which the SSL certificate is valid.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsSSLCertificateIssuer.html b/classes/v1.SyntheticsSSLCertificateIssuer.html index 03dd72ab4d2..5c6750c55d4 100644 --- a/classes/v1.SyntheticsSSLCertificateIssuer.html +++ b/classes/v1.SyntheticsSSLCertificateIssuer.html @@ -1,15 +1,15 @@ SyntheticsSSLCertificateIssuer | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsSSLCertificateIssuer

Object describing the issuer of a SSL certificate.

-

Hierarchy

  • SyntheticsSSLCertificateIssuer

Index

Constructors

Properties

Constructors

constructor

Properties

Optional C

C?: string
+

Hierarchy

  • SyntheticsSSLCertificateIssuer

Index

Constructors

Properties

Constructors

constructor

Properties

Optional C

C?: string

Country Name that issued the certificate.

-

Optional CN

CN?: string
+

Optional CN

CN?: string

Common Name that issued certificate.

-

Optional L

L?: string
+

Optional L

L?: string

Locality that issued the certificate.

-

Optional O

O?: string
+

Optional O

O?: string

Organization that issued the certificate.

-

Optional OU

OU?: string
+

Optional OU

OU?: string

Organizational Unit that issued the certificate.

-

Optional ST

ST?: string
+

Optional ST

ST?: string

State Or Province Name that issued the certificate.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsSSLCertificateSubject.html b/classes/v1.SyntheticsSSLCertificateSubject.html index 74607492aa4..c8ef4b968fd 100644 --- a/classes/v1.SyntheticsSSLCertificateSubject.html +++ b/classes/v1.SyntheticsSSLCertificateSubject.html @@ -1,17 +1,17 @@ SyntheticsSSLCertificateSubject | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsSSLCertificateSubject

Object describing the SSL certificate used for the test.

-

Hierarchy

  • SyntheticsSSLCertificateSubject

Index

Constructors

Properties

Constructors

constructor

Properties

Optional C

C?: string
+

Hierarchy

  • SyntheticsSSLCertificateSubject

Index

Constructors

Properties

Constructors

constructor

Properties

Optional C

C?: string

Country Name associated with the certificate.

-

Optional CN

CN?: string
+

Optional CN

CN?: string

Common Name that associated with the certificate.

-

Optional L

L?: string
+

Optional L

L?: string

Locality associated with the certificate.

-

Optional O

O?: string
+

Optional O

O?: string

Organization associated with the certificate.

-

Optional OU

OU?: string
+

Optional OU

OU?: string

Organizational Unit associated with the certificate.

-

Optional ST

ST?: string
+

Optional ST

ST?: string

State Or Province Name associated with the certificate.

-

Optional altName

altName?: string
+

Optional altName

altName?: string

Subject Alternative Name associated with the certificate.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsStep.html b/classes/v1.SyntheticsStep.html index 6805a375522..209c3413e84 100644 --- a/classes/v1.SyntheticsStep.html +++ b/classes/v1.SyntheticsStep.html @@ -1,13 +1,13 @@ SyntheticsStep | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsStep

The steps used in a Synthetics browser test.

-

Hierarchy

  • SyntheticsStep

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowFailure

allowFailure?: boolean
+

Hierarchy

  • SyntheticsStep

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowFailure

allowFailure?: boolean

A boolean set to allow this step to fail.

-

Optional isCritical

isCritical?: boolean
+

Optional isCritical

isCritical?: boolean

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the step.

-

Optional params

params?: any
+

Optional params

params?: any

The parameters of the step.

-

Optional timeout

timeout?: number
+

Optional timeout

timeout?: number

The time before declaring a step failed.

-

Optional type

type?: SyntheticsStepType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: SyntheticsStepType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsStepDetail.html b/classes/v1.SyntheticsStepDetail.html index a285c4b69e7..e8e34d66e41 100644 --- a/classes/v1.SyntheticsStepDetail.html +++ b/classes/v1.SyntheticsStepDetail.html @@ -1,31 +1,31 @@ SyntheticsStepDetail | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsStepDetail

Object describing a step for a Synthetic test.

-

Hierarchy

  • SyntheticsStepDetail

Index

Constructors

Properties

Constructors

constructor

Properties

Optional browserErrors

browserErrors?: SyntheticsBrowserError[]
+

Hierarchy

  • SyntheticsStepDetail

Index

Constructors

Properties

Constructors

constructor

Properties

Optional browserErrors

browserErrors?: SyntheticsBrowserError[]

Array of errors collected for a browser test.

-

Optional checkType

checkType?: SyntheticsCheckType

Optional description

description?: string
+

Optional checkType

checkType?: SyntheticsCheckType

Optional description

description?: string

Description of the test.

-

Optional duration

duration?: number
+

Optional duration

duration?: number

Total duration in millisecond of the test.

-

Optional error

error?: string
+

Optional error

error?: string

Error returned by the test.

-

Optional playingTab

playingTab?: SyntheticsPlayingTab

Optional screenshotBucketKey

screenshotBucketKey?: boolean
+

Optional playingTab

playingTab?: SyntheticsPlayingTab

Optional screenshotBucketKey

screenshotBucketKey?: boolean

Whether or not screenshots where collected by the test.

-

Optional skipped

skipped?: boolean
+

Optional skipped

skipped?: boolean

Whether or not to skip this step.

-

Optional snapshotBucketKey

snapshotBucketKey?: boolean
+

Optional snapshotBucketKey

snapshotBucketKey?: boolean

Whether or not snapshots where collected by the test.

-

Optional stepId

stepId?: number
+

Optional stepId

stepId?: number

The step ID.

-

Optional subTestStepDetails

subTestStepDetails?: SyntheticsStepDetail[]
+

Optional subTestStepDetails

subTestStepDetails?: SyntheticsStepDetail[]

If this steps include a sub-test. Subtests documentation.

-

Optional timeToInteractive

timeToInteractive?: number
+

Optional timeToInteractive

timeToInteractive?: number

Time before starting the step.

-

Optional type

type?: SyntheticsStepType

Optional url

url?: string
+

Optional type

type?: SyntheticsStepType

Optional url

url?: string

URL to perform the step against.

-

Optional value

value?: any
+

Optional value

value?: any

Value for the step.

-

Optional vitalsMetrics

vitalsMetrics?: SyntheticsCoreWebVitals[]
+

Optional vitalsMetrics

vitalsMetrics?: SyntheticsCoreWebVitals[]

Array of Core Web Vitals metrics for the step.

-

Optional warnings

warnings?: SyntheticsStepDetailWarning[]
+

Optional warnings

warnings?: SyntheticsStepDetailWarning[]

Warning collected that didn't failed the step.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsStepDetailWarning.html b/classes/v1.SyntheticsStepDetailWarning.html index 85d4f7710fd..23fc55c547f 100644 --- a/classes/v1.SyntheticsStepDetailWarning.html +++ b/classes/v1.SyntheticsStepDetailWarning.html @@ -1,5 +1,5 @@ SyntheticsStepDetailWarning | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsStepDetailWarning

Object collecting warnings for a given step.

-

Hierarchy

  • SyntheticsStepDetailWarning

Index

Constructors

Properties

Constructors

constructor

Properties

message

message: string
+

Hierarchy

  • SyntheticsStepDetailWarning

Index

Constructors

Properties

Constructors

constructor

Properties

message

message: string

Message for the warning.

-

type

type: "user_locator"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "user_locator"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestConfig.html b/classes/v1.SyntheticsTestConfig.html index 6e6abd08ded..814f27eb728 100644 --- a/classes/v1.SyntheticsTestConfig.html +++ b/classes/v1.SyntheticsTestConfig.html @@ -1,9 +1,9 @@ SyntheticsTestConfig | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestConfig

Configuration object for a Synthetic test.

-

Hierarchy

  • SyntheticsTestConfig

Index

Constructors

Properties

Constructors

constructor

Properties

Optional assertions

assertions?: SyntheticsAssertion[]
+

Hierarchy

  • SyntheticsTestConfig

Index

Constructors

Properties

Constructors

constructor

Properties

Optional assertions

assertions?: SyntheticsAssertion[]

Array of assertions used for the test. Required for single API tests.

-

Optional configVariables

configVariables?: SyntheticsConfigVariable[]
+

Optional configVariables

configVariables?: SyntheticsConfigVariable[]

Array of variables used for the test.

-

Optional request

request?: SyntheticsTestRequest

Optional variables

variables?: SyntheticsBrowserVariable[]
+

Optional request

request?: SyntheticsTestRequest

Optional variables

variables?: SyntheticsBrowserVariable[]

Browser tests only - array of variables used for the test steps.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestDetails.html b/classes/v1.SyntheticsTestDetails.html index 22d28a22f02..088d1baa1cb 100644 --- a/classes/v1.SyntheticsTestDetails.html +++ b/classes/v1.SyntheticsTestDetails.html @@ -1,17 +1,17 @@ SyntheticsTestDetails | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestDetails

Object containing details about your Synthetic test.

-

Hierarchy

  • SyntheticsTestDetails

Index

Constructors

Properties

Constructors

constructor

Properties

Optional config

config?: SyntheticsTestConfig

Optional creator

creator?: v1.Creator

Optional locations

locations?: string[]
+

Hierarchy

  • SyntheticsTestDetails

Index

Constructors

Properties

Constructors

constructor

Properties

Optional config

config?: SyntheticsTestConfig

Optional creator

creator?: v1.Creator

Optional locations

locations?: string[]

Array of locations used to run the test.

-

Optional message

message?: string
+

Optional message

message?: string

Notification message associated with the test.

-

Optional monitorId

monitorId?: number
+

Optional monitorId

monitorId?: number

The associated monitor ID.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the test.

-

Optional options

options?: SyntheticsTestOptions

Optional publicId

publicId?: string
+

Optional options

options?: SyntheticsTestOptions

Optional publicId

publicId?: string

The test public ID.

-

Optional status

status?: SyntheticsTestPauseStatus

Optional steps

steps?: SyntheticsStep[]
+

Optional status

status?: SyntheticsTestPauseStatus

Optional steps

steps?: SyntheticsStep[]

For browser test, the steps of the test.

-

Optional subtype

subtype?: SyntheticsTestDetailsSubType

Optional tags

tags?: string[]
+

Optional subtype

subtype?: SyntheticsTestDetailsSubType

Optional tags

tags?: string[]

Array of tags attached to the test.

-

Optional type

type?: SyntheticsTestDetailsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: SyntheticsTestDetailsType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestOptions.html b/classes/v1.SyntheticsTestOptions.html index dbc245b3784..1eca0f3b0a4 100644 --- a/classes/v1.SyntheticsTestOptions.html +++ b/classes/v1.SyntheticsTestOptions.html @@ -1,25 +1,25 @@ SyntheticsTestOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

-

Hierarchy

  • SyntheticsTestOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional acceptSelfSigned

acceptSelfSigned?: boolean
+

Hierarchy

  • SyntheticsTestOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional acceptSelfSigned

acceptSelfSigned?: boolean

For SSL test, whether or not the test should allow self signed certificates.

-

Optional allowInsecure

allowInsecure?: boolean
+

Optional allowInsecure

allowInsecure?: boolean

Allows loading insecure content for an HTTP request.

-

Optional deviceIds

deviceIds?: SyntheticsDeviceID[]
+

Optional deviceIds

deviceIds?: SyntheticsDeviceID[]

For browser test, array with the different device IDs used to run the test.

-

Optional disableCors

disableCors?: boolean
+

Optional disableCors

disableCors?: boolean

Whether or not to disable CORS mechanism.

-

Optional followRedirects

followRedirects?: boolean
+

Optional followRedirects

followRedirects?: boolean

For API HTTP test, whether or not the test should follow redirects.

-

Optional minFailureDuration

minFailureDuration?: number
+

Optional minFailureDuration

minFailureDuration?: number

Minimum amount of time in failure required to trigger an alert.

-

Optional minLocationFailed

minLocationFailed?: number
+

Optional minLocationFailed

minLocationFailed?: number

Minimum number of locations in failure required to trigger an alert.

-

Optional monitorName

monitorName?: string
+

Optional monitorName

monitorName?: string

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

-

Optional monitorOptions

monitorOptions?: SyntheticsTestOptionsMonitorOptions

Optional monitorPriority

monitorPriority?: number
+

Optional monitorOptions

monitorOptions?: SyntheticsTestOptionsMonitorOptions

Optional monitorPriority

monitorPriority?: number

Integer from 1 (high) to 5 (low) indicating alert severity.

-

Optional noScreenshot

noScreenshot?: boolean
+

Optional noScreenshot

noScreenshot?: boolean

Prevents saving screenshots of the steps.

-

Optional retry

retry?: SyntheticsTestOptionsRetry

Optional tickEvery

tickEvery?: number
+

Optional retry

retry?: SyntheticsTestOptionsRetry

Optional tickEvery

tickEvery?: number

The frequency at which to run the Synthetic test (in seconds).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestOptionsMonitorOptions.html b/classes/v1.SyntheticsTestOptionsMonitorOptions.html index fb255c2f4a0..b5788e57f00 100644 --- a/classes/v1.SyntheticsTestOptionsMonitorOptions.html +++ b/classes/v1.SyntheticsTestOptionsMonitorOptions.html @@ -1,5 +1,5 @@ SyntheticsTestOptionsMonitorOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestOptionsMonitorOptions

Object containing the options for a Synthetic test as a monitor (for example, renotification).

-

Hierarchy

  • SyntheticsTestOptionsMonitorOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional renotifyInterval

renotifyInterval?: number
+

Hierarchy

  • SyntheticsTestOptionsMonitorOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional renotifyInterval

renotifyInterval?: number

Time interval before renotifying if the test is still failing (in minutes).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestOptionsRetry.html b/classes/v1.SyntheticsTestOptionsRetry.html index 72d1d7b4d3f..10874730443 100644 --- a/classes/v1.SyntheticsTestOptionsRetry.html +++ b/classes/v1.SyntheticsTestOptionsRetry.html @@ -1,7 +1,7 @@ SyntheticsTestOptionsRetry | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestOptionsRetry

Object describing the retry strategy to apply to a Synthetic test.

-

Hierarchy

  • SyntheticsTestOptionsRetry

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number
+

Hierarchy

  • SyntheticsTestOptionsRetry

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Number of times a test needs to be retried before marking a location as failed. Defaults to 0.

-

Optional interval

interval?: number
+

Optional interval

interval?: number

Time interval between retries (in milliseconds). Defaults to 300ms.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestRequest.html b/classes/v1.SyntheticsTestRequest.html index b70a20daf82..0ab7bfd86f3 100644 --- a/classes/v1.SyntheticsTestRequest.html +++ b/classes/v1.SyntheticsTestRequest.html @@ -1,35 +1,35 @@ SyntheticsTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestRequest

Object describing the Synthetic test request.

-

Hierarchy

  • SyntheticsTestRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowInsecure

allowInsecure?: boolean
+

Hierarchy

  • SyntheticsTestRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional allowInsecure

allowInsecure?: boolean

Allows loading insecure content for an HTTP request in a multistep test step.

-

Optional basicAuth

basicAuth?: SyntheticsBasicAuth

Optional body

body?: string
+

Optional basicAuth

basicAuth?: SyntheticsBasicAuth

Optional body

body?: string

Body to include in the test.

-

Optional certificate

certificate?: SyntheticsTestRequestCertificate

Optional dnsServer

dnsServer?: string
+

Optional certificate

certificate?: SyntheticsTestRequestCertificate

Optional dnsServer

dnsServer?: string

DNS server to use for DNS tests.

-

Optional dnsServerPort

dnsServerPort?: number
+

Optional dnsServerPort

dnsServerPort?: number

DNS server port to use for DNS tests.

-

Optional followRedirects

followRedirects?: boolean
+

Optional followRedirects

followRedirects?: boolean

Specifies whether or not the request follows redirects.

-

Optional headers

headers?: {}
+

Optional headers

headers?: {}

Headers to include when performing the test.

-

Type declaration

  • [key: string]: string

Optional host

host?: string
+

Type declaration

  • [key: string]: string

Optional host

host?: string

Host name to perform the test with.

-

Optional message

message?: string
+

Optional message

message?: string

Message to send for UDP or WebSocket tests.

-

Optional method

method?: HTTPMethod

Optional noSavingResponseBody

noSavingResponseBody?: boolean
+

Optional method

method?: HTTPMethod

Optional noSavingResponseBody

noSavingResponseBody?: boolean

Determines whether or not to save the response body.

-

Optional numberOfPackets

numberOfPackets?: number
+

Optional numberOfPackets

numberOfPackets?: number

Number of pings to use per test.

-

Optional port

port?: number
+

Optional port

port?: number

Port to use when performing the test.

-

Optional proxy

proxy?: SyntheticsTestRequestProxy

Optional query

query?: any
+

Optional proxy

proxy?: SyntheticsTestRequestProxy

Optional query

query?: any

Query to use for the test.

-

Optional servername

servername?: string
+

Optional servername

servername?: string

For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

-

Optional shouldTrackHops

shouldTrackHops?: boolean
+

Optional shouldTrackHops

shouldTrackHops?: boolean

Turns on a traceroute probe to discover all gateways along the path to the host destination.

-

Optional timeout

timeout?: number
+

Optional timeout

timeout?: number

Timeout in seconds for the test.

-

Optional url

url?: string
+

Optional url

url?: string

URL to perform the test with.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestRequestCertificate.html b/classes/v1.SyntheticsTestRequestCertificate.html index d551d90ca40..b0a018d15fb 100644 --- a/classes/v1.SyntheticsTestRequestCertificate.html +++ b/classes/v1.SyntheticsTestRequestCertificate.html @@ -1,3 +1,3 @@ SyntheticsTestRequestCertificate | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestRequestCertificate

Client certificate to use when performing the test request.

-

Hierarchy

  • SyntheticsTestRequestCertificate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cert

cert?: SyntheticsTestRequestCertificateItem

Optional key

key?: SyntheticsTestRequestCertificateItem

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsTestRequestCertificate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cert

cert?: SyntheticsTestRequestCertificateItem

Optional key

key?: SyntheticsTestRequestCertificateItem

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestRequestCertificateItem.html b/classes/v1.SyntheticsTestRequestCertificateItem.html index ae3eec1d629..ea581ee8f08 100644 --- a/classes/v1.SyntheticsTestRequestCertificateItem.html +++ b/classes/v1.SyntheticsTestRequestCertificateItem.html @@ -1,9 +1,9 @@ SyntheticsTestRequestCertificateItem | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestRequestCertificateItem

Define a request certificate.

-

Hierarchy

  • SyntheticsTestRequestCertificateItem

Index

Constructors

Properties

Constructors

constructor

Properties

Optional content

content?: string
+

Hierarchy

  • SyntheticsTestRequestCertificateItem

Index

Constructors

Properties

Constructors

constructor

Properties

Optional content

content?: string

Content of the certificate or key.

-

Optional filename

filename?: string
+

Optional filename

filename?: string

File name for the certificate or key.

-

Optional updatedAt

updatedAt?: string
+

Optional updatedAt

updatedAt?: string

Date of update of the certificate or key, ISO format.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTestRequestProxy.html b/classes/v1.SyntheticsTestRequestProxy.html index db864f07efb..37a02dde03b 100644 --- a/classes/v1.SyntheticsTestRequestProxy.html +++ b/classes/v1.SyntheticsTestRequestProxy.html @@ -1,7 +1,7 @@ SyntheticsTestRequestProxy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTestRequestProxy

The proxy to perform the test.

-

Hierarchy

  • SyntheticsTestRequestProxy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional headers

headers?: {}
+

Hierarchy

  • SyntheticsTestRequestProxy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional headers

headers?: {}

Headers to include when performing the test.

-

Type declaration

  • [key: string]: string

url

url: string
+

Type declaration

  • [key: string]: string

url

url: string

URL of the proxy to perform the test.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTiming.html b/classes/v1.SyntheticsTiming.html index 61bf2c8c274..640dc5948d2 100644 --- a/classes/v1.SyntheticsTiming.html +++ b/classes/v1.SyntheticsTiming.html @@ -1,21 +1,21 @@ SyntheticsTiming | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTiming

Object containing all metrics and their values collected for a Synthetic API test. Learn more about those metrics in Synthetics documentation.

-

Hierarchy

  • SyntheticsTiming

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dns

dns?: number
+

Hierarchy

  • SyntheticsTiming

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dns

dns?: number

The duration in millisecond of the DNS lookup.

-

Optional download

download?: number
+

Optional download

download?: number

The time in millisecond to download the response.

-

Optional firstByte

firstByte?: number
+

Optional firstByte

firstByte?: number

The time in millisecond to first byte.

-

Optional handshake

handshake?: number
+

Optional handshake

handshake?: number

The duration in millisecond of the TLS handshake.

-

Optional redirect

redirect?: number
+

Optional redirect

redirect?: number

The time in millisecond spent during redirections.

-

Optional ssl

ssl?: number
+

Optional ssl

ssl?: number

The duration in millisecond of the TLS handshake.

-

Optional tcp

tcp?: number
+

Optional tcp

tcp?: number

Time in millisecond to establish the TCP connection.

-

Optional total

total?: number
+

Optional total

total?: number

The overall time in millisecond the request took to be processed.

-

Optional wait

wait?: number
+

Optional wait

wait?: number

Time spent in millisecond waiting for a response.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTriggerBody.html b/classes/v1.SyntheticsTriggerBody.html index c444a00927d..67a28979c34 100644 --- a/classes/v1.SyntheticsTriggerBody.html +++ b/classes/v1.SyntheticsTriggerBody.html @@ -1,5 +1,5 @@ SyntheticsTriggerBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTriggerBody

Object describing the synthetics tests to trigger.

-

Hierarchy

  • SyntheticsTriggerBody

Index

Constructors

Properties

Constructors

constructor

Properties

tests

tests: SyntheticsTriggerTest[]
+

Hierarchy

  • SyntheticsTriggerBody

Index

Constructors

Properties

Constructors

constructor

Properties

tests

tests: SyntheticsTriggerTest[]

Individual synthetics test.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTriggerCITestLocation.html b/classes/v1.SyntheticsTriggerCITestLocation.html index 8372bbcf56c..42d9daaa53a 100644 --- a/classes/v1.SyntheticsTriggerCITestLocation.html +++ b/classes/v1.SyntheticsTriggerCITestLocation.html @@ -1,7 +1,7 @@ SyntheticsTriggerCITestLocation | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTriggerCITestLocation

Synthetics location.

-

Hierarchy

  • SyntheticsTriggerCITestLocation

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: number
+

Hierarchy

  • SyntheticsTriggerCITestLocation

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: number

Unique identifier of the location.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the location.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTriggerCITestRunResult.html b/classes/v1.SyntheticsTriggerCITestRunResult.html index 5f3e56d5ef3..6789dcf3b8d 100644 --- a/classes/v1.SyntheticsTriggerCITestRunResult.html +++ b/classes/v1.SyntheticsTriggerCITestRunResult.html @@ -1,9 +1,9 @@ SyntheticsTriggerCITestRunResult | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTriggerCITestRunResult

Information about a single test run.

-

Hierarchy

  • SyntheticsTriggerCITestRunResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional device

device?: SyntheticsDeviceID

Optional location

location?: number
+

Hierarchy

  • SyntheticsTriggerCITestRunResult

Index

Constructors

Properties

Constructors

constructor

Properties

Optional device

device?: SyntheticsDeviceID

Optional location

location?: number

The location ID of the test run.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The public ID of the Synthetics test.

-

Optional resultId

resultId?: string
+

Optional resultId

resultId?: string

ID of the result.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTriggerCITestsResponse.html b/classes/v1.SyntheticsTriggerCITestsResponse.html index 6fea91d15a8..59dda9802a7 100644 --- a/classes/v1.SyntheticsTriggerCITestsResponse.html +++ b/classes/v1.SyntheticsTriggerCITestsResponse.html @@ -1,11 +1,11 @@ SyntheticsTriggerCITestsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTriggerCITestsResponse

Object containing information about the tests triggered.

-

Hierarchy

  • SyntheticsTriggerCITestsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional batchId

batchId?: string
+

Hierarchy

  • SyntheticsTriggerCITestsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional batchId

batchId?: string

The public ID of the batch triggered.

-

Optional locations

locations?: SyntheticsTriggerCITestLocation[]
+

Optional locations

locations?: SyntheticsTriggerCITestLocation[]

List of Synthetics locations.

-

Optional results

results?: SyntheticsTriggerCITestRunResult[]
+

Optional results

results?: SyntheticsTriggerCITestRunResult[]

Information about the tests runs.

-

Optional triggeredCheckIds

triggeredCheckIds?: string[]
+

Optional triggeredCheckIds

triggeredCheckIds?: string[]

The public IDs of the Synthetics test triggered.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsTriggerTest.html b/classes/v1.SyntheticsTriggerTest.html index cc2157ff17f..735a73a0e35 100644 --- a/classes/v1.SyntheticsTriggerTest.html +++ b/classes/v1.SyntheticsTriggerTest.html @@ -1,5 +1,5 @@ SyntheticsTriggerTest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsTriggerTest

Test configuration for Synthetics

-

Hierarchy

  • SyntheticsTriggerTest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: SyntheticsCIBatchMetadata

publicId

publicId: string
+

Hierarchy

  • SyntheticsTriggerTest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: SyntheticsCIBatchMetadata

publicId

publicId: string

The public ID of the Synthetics test to trigger.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsUpdateTestPauseStatusPayload.html b/classes/v1.SyntheticsUpdateTestPauseStatusPayload.html index 058d8adb3e3..4457bc91273 100644 --- a/classes/v1.SyntheticsUpdateTestPauseStatusPayload.html +++ b/classes/v1.SyntheticsUpdateTestPauseStatusPayload.html @@ -1,3 +1,3 @@ SyntheticsUpdateTestPauseStatusPayload | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsUpdateTestPauseStatusPayload

Object to start or pause an existing Synthetic test.

-

Hierarchy

  • SyntheticsUpdateTestPauseStatusPayload

Index

Constructors

Properties

Constructors

constructor

Properties

Optional newStatus

newStatus?: SyntheticsTestPauseStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SyntheticsUpdateTestPauseStatusPayload

Index

Constructors

Properties

Constructors

constructor

Properties

Optional newStatus

newStatus?: SyntheticsTestPauseStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.SyntheticsVariableParser.html b/classes/v1.SyntheticsVariableParser.html index 4ad75ed5e95..440ae7712cb 100644 --- a/classes/v1.SyntheticsVariableParser.html +++ b/classes/v1.SyntheticsVariableParser.html @@ -1,5 +1,5 @@ SyntheticsVariableParser | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyntheticsVariableParser

Details of the parser to use for the global variable.

-

Hierarchy

  • SyntheticsVariableParser

Index

Constructors

Properties

Constructors

constructor

Properties

type

type: SyntheticsGlobalVariableParserType

Optional value

value?: string
+

Hierarchy

  • SyntheticsVariableParser

Index

Constructors

Properties

Constructors

constructor

Properties

type

type: SyntheticsGlobalVariableParserType

Optional value

value?: string

Regex or JSON path used for the parser. Not used with type raw.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TableWidgetDefinition.html b/classes/v1.TableWidgetDefinition.html index 4c0e1ffea4c..7c3dcfc71eb 100644 --- a/classes/v1.TableWidgetDefinition.html +++ b/classes/v1.TableWidgetDefinition.html @@ -1,11 +1,11 @@ TableWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableWidgetDefinition

The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.

-

Hierarchy

  • TableWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]
+

Hierarchy

  • TableWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

-

Optional hasSearchBar

hasSearchBar?: TableWidgetHasSearchBar

requests

requests: TableWidgetRequest[]
+

Optional hasSearchBar

hasSearchBar?: TableWidgetHasSearchBar

requests

requests: TableWidgetRequest[]

Widget definition.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of your widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "query_table"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "query_table"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TableWidgetRequest.html b/classes/v1.TableWidgetRequest.html index 69193afaa98..ab21819023a 100644 --- a/classes/v1.TableWidgetRequest.html +++ b/classes/v1.TableWidgetRequest.html @@ -1,17 +1,17 @@ TableWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableWidgetRequest

Updated table widget.

-

Hierarchy

  • TableWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: WidgetAggregator

Optional alias

alias?: string
+

Hierarchy

  • TableWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregator

aggregator?: WidgetAggregator

Optional alias

alias?: string

The column name (defaults to the metric name).

-

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional apmStatsQuery

apmStatsQuery?: ApmStatsQueryDefinition

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode[]
+

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional apmStatsQuery

apmStatsQuery?: ApmStatsQueryDefinition

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode[]

A list of display modes for each table cell.

-

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]
+

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]

List of conditional formats.

-

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]
+

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

For metric queries, the number of lines to show in the table. Only one request should have this property.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional order

order?: WidgetSort

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional order

order?: WidgetSort

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Query definition.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TagToHosts.html b/classes/v1.TagToHosts.html index 87033869595..83661725449 100644 --- a/classes/v1.TagToHosts.html +++ b/classes/v1.TagToHosts.html @@ -1,5 +1,5 @@ TagToHosts | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TagToHosts

In this object, the key is the tag, the value is a list of host names that are reporting that tag.

-

Hierarchy

  • TagToHosts

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tags

tags?: {}
+

Hierarchy

  • TagToHosts

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tags

tags?: {}

A list of tags to apply to the host.

Type declaration

  • [key: string]: string[]

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TagsApi.html b/classes/v1.TagsApi.html index 29264a0b574..58f4be8ffac 100644 --- a/classes/v1.TagsApi.html +++ b/classes/v1.TagsApi.html @@ -1,20 +1,20 @@ -TagsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TagsApi

Hierarchy

  • TagsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TagsApi(configuration: v1.Configuration, requestFactory?: TagsApiRequestFactory, responseProcessor?: TagsApiResponseProcessor): TagsApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: TagsApiRequestFactory

Private responseProcessor

responseProcessor: TagsApiResponseProcessor

Methods

createHostTags

deleteHostTags

getHostTags

Returns Promise<void>

getHostTags

listHostTags

Returns Promise<HostTags>

listHostTags

updateHostTags

Returns Promise<TagToHosts>

updateHostTags

type

type: "timeseries"

Optional yaxis

yaxis?: WidgetAxis

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TimeseriesWidgetExpressionAlias.html b/classes/v1.TimeseriesWidgetExpressionAlias.html index 8a0e1862dfb..72585658cef 100644 --- a/classes/v1.TimeseriesWidgetExpressionAlias.html +++ b/classes/v1.TimeseriesWidgetExpressionAlias.html @@ -1,7 +1,7 @@ TimeseriesWidgetExpressionAlias | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimeseriesWidgetExpressionAlias

Define an expression alias.

-

Hierarchy

  • TimeseriesWidgetExpressionAlias

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aliasName

aliasName?: string
+

Hierarchy

  • TimeseriesWidgetExpressionAlias

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aliasName

aliasName?: string

Expression alias.

-

expression

expression: string
+

expression

expression: string

Expression name.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TimeseriesWidgetRequest.html b/classes/v1.TimeseriesWidgetRequest.html index 110f1fa7d96..f40170a89b1 100644 --- a/classes/v1.TimeseriesWidgetRequest.html +++ b/classes/v1.TimeseriesWidgetRequest.html @@ -1,13 +1,13 @@ TimeseriesWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimeseriesWidgetRequest

Updated timeseries widget.

-

Hierarchy

  • TimeseriesWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional displayType

displayType?: WidgetDisplayType

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]
+

Hierarchy

  • TimeseriesWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional displayType

displayType?: WidgetDisplayType

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional metadata

metadata?: TimeseriesWidgetExpressionAlias[]
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional metadata

metadata?: TimeseriesWidgetExpressionAlias[]

Used to define expression aliases.

-

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional onRightYaxis

onRightYaxis?: boolean
+

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional onRightYaxis

onRightYaxis?: boolean

Whether or not to display a second y-axis on the right.

-

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Widget query.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetRequestStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetRequestStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ToplistWidgetDefinition.html b/classes/v1.ToplistWidgetDefinition.html index 5adaabbb35c..9e854d4a9d0 100644 --- a/classes/v1.ToplistWidgetDefinition.html +++ b/classes/v1.ToplistWidgetDefinition.html @@ -1,11 +1,11 @@ ToplistWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ToplistWidgetDefinition

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

-

Hierarchy

  • ToplistWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]
+

Hierarchy

  • ToplistWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

-

requests

requests: ToplistWidgetRequest[]
+

requests

requests: ToplistWidgetRequest[]

List of top list widget requests.

-

Optional time

time?: WidgetTime

Optional title

title?: string
+

Optional time

time?: WidgetTime

Optional title

title?: string

Title of your widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string
+

Optional titleAlign

titleAlign?: WidgetTextAlign

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "toplist"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "toplist"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ToplistWidgetRequest.html b/classes/v1.ToplistWidgetRequest.html index 2309042112a..7dac6eacd50 100644 --- a/classes/v1.ToplistWidgetRequest.html +++ b/classes/v1.ToplistWidgetRequest.html @@ -1,11 +1,11 @@ ToplistWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ToplistWidgetRequest

Updated top list widget.

-

Hierarchy

  • ToplistWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]
+

Hierarchy

  • ToplistWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

Optional auditQuery

auditQuery?: LogQueryDefinition

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]

List of conditional formats.

-

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]
+

Optional eventQuery

eventQuery?: LogQueryDefinition

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string
+

Optional logQuery

logQuery?: LogQueryDefinition

Optional networkQuery

networkQuery?: LogQueryDefinition

Optional processQuery

processQuery?: ProcessQueryDefinition

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

Optional q

q?: string

Widget query.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetRequestStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Optional rumQuery

rumQuery?: LogQueryDefinition

Optional securityQuery

securityQuery?: LogQueryDefinition

Optional style

style?: WidgetRequestStyle

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TreeMapWidgetDefinition.html b/classes/v1.TreeMapWidgetDefinition.html index d11583965de..1d736f7a469 100644 --- a/classes/v1.TreeMapWidgetDefinition.html +++ b/classes/v1.TreeMapWidgetDefinition.html @@ -1,7 +1,7 @@ TreeMapWidgetDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TreeMapWidgetDefinition

The treemap visualization found on the Host Dashboards comes from the output of ps auxww. This is not continuously run on your hosts. Instead, it’s run once on Agent start/restart. The treemap is only supported for process data on a single host dashboard — this may not be reused in other dashboards or for other metrics.

-

Hierarchy

  • TreeMapWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional colorBy

colorBy?: "user"

Optional groupBy

groupBy?: TreeMapGroupBy

requests

requests: TreeMapWidgetRequest[]
+

Hierarchy

  • TreeMapWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional colorBy

colorBy?: "user"

Optional groupBy

groupBy?: TreeMapGroupBy

requests

requests: TreeMapWidgetRequest[]

List of top list widget requests.

-

Optional sizeBy

sizeBy?: TreeMapSizeBy

Optional title

title?: string
+

Optional sizeBy

sizeBy?: TreeMapSizeBy

Optional title

title?: string

Title of your widget.

-

type

type: "treemap"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "treemap"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.TreeMapWidgetRequest.html b/classes/v1.TreeMapWidgetRequest.html index 2b7e37fac02..e43557806da 100644 --- a/classes/v1.TreeMapWidgetRequest.html +++ b/classes/v1.TreeMapWidgetRequest.html @@ -1,9 +1,9 @@ TreeMapWidgetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TreeMapWidgetRequest

An updated treemap widget.

-

Hierarchy

  • TreeMapWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional formulas

formulas?: WidgetFormula[]
+

Hierarchy

  • TreeMapWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional formulas

formulas?: WidgetFormula[]

List of formulas that operate on queries. This feature is currently in beta.

-

Optional q

q?: string
+

Optional q

q?: string

The widget metrics query.

-

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]
+

Optional queries

queries?: FormulaAndFunctionQueryDefinition[]

List of queries that can be returned directly or used in formulas. This feature is currently in beta.

-

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional responseFormat

responseFormat?: FormulaAndFunctionResponseFormat

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAnalyzedLogsHour.html b/classes/v1.UsageAnalyzedLogsHour.html index 8108f4f8cb9..5d3148aebc1 100644 --- a/classes/v1.UsageAnalyzedLogsHour.html +++ b/classes/v1.UsageAnalyzedLogsHour.html @@ -1,11 +1,11 @@ UsageAnalyzedLogsHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAnalyzedLogsHour

The number of analyzed logs for each hour for a given organization.

-

Hierarchy

  • UsageAnalyzedLogsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional analyzedLogs

analyzedLogs?: number
+

Hierarchy

  • UsageAnalyzedLogsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional analyzedLogs

analyzedLogs?: number

Contains the number of analyzed logs.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAnalyzedLogsResponse.html b/classes/v1.UsageAnalyzedLogsResponse.html index 2ce9915e8eb..016a5c21ec5 100644 --- a/classes/v1.UsageAnalyzedLogsResponse.html +++ b/classes/v1.UsageAnalyzedLogsResponse.html @@ -1,5 +1,5 @@ UsageAnalyzedLogsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAnalyzedLogsResponse

A response containing the number of analyzed logs for each hour for a given organization.

-

Hierarchy

  • UsageAnalyzedLogsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageAnalyzedLogsHour[]
+

Hierarchy

  • UsageAnalyzedLogsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageAnalyzedLogsHour[]

Get hourly usage for analyzed logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAttributionAggregatesBody.html b/classes/v1.UsageAttributionAggregatesBody.html index f91ab2a2632..d07874ac4e8 100644 --- a/classes/v1.UsageAttributionAggregatesBody.html +++ b/classes/v1.UsageAttributionAggregatesBody.html @@ -1,9 +1,9 @@ UsageAttributionAggregatesBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAttributionAggregatesBody

The object containing the aggregates.

-

Hierarchy

  • UsageAttributionAggregatesBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggType

aggType?: string
+

Hierarchy

  • UsageAttributionAggregatesBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggType

aggType?: string

The aggregate type.

-

Optional field

field?: string
+

Optional field

field?: string

The field.

-

Optional value

value?: number
+

Optional value

value?: number

The value for a given field.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAttributionBody.html b/classes/v1.UsageAttributionBody.html index 48347b0285f..019c89b64c4 100644 --- a/classes/v1.UsageAttributionBody.html +++ b/classes/v1.UsageAttributionBody.html @@ -1,15 +1,15 @@ UsageAttributionBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAttributionBody

Usage Summary by tag for a given organization.

-

Hierarchy

  • UsageAttributionBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional month

month?: Date
+

Hierarchy

  • UsageAttributionBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional month

month?: Date

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM].

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The name of the organization.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

-

Optional tagConfigSource

tagConfigSource?: string
+

Optional tagConfigSource

tagConfigSource?: string

The source of the usage attribution tag configuration and the selected tags in the format <source_org_name>:<selected tag 1>-<selected tag 2>-<selected tag 3>.

-

Optional tags

tags?: {}
+

Optional tags

tags?: {}

Usage Summary by tag name.

-

Type declaration

  • [key: string]: string[]

Optional updatedAt

updatedAt?: string
+

Type declaration

  • [key: string]: string[]

Optional updatedAt

updatedAt?: string

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

-

Optional values

values?: UsageAttributionValues

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional values

values?: UsageAttributionValues

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAttributionMetadata.html b/classes/v1.UsageAttributionMetadata.html index 32169a50cd1..98d82b96897 100644 --- a/classes/v1.UsageAttributionMetadata.html +++ b/classes/v1.UsageAttributionMetadata.html @@ -1,5 +1,5 @@ UsageAttributionMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAttributionMetadata

The object containing document metadata.

-

Hierarchy

  • UsageAttributionMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregates

aggregates?: UsageAttributionAggregatesBody[]
+

Hierarchy

  • UsageAttributionMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregates

aggregates?: UsageAttributionAggregatesBody[]

An array of available aggregates.

-

Optional pagination

pagination?: UsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional pagination

pagination?: UsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAttributionPagination.html b/classes/v1.UsageAttributionPagination.html index 3bd28d4f21a..133c08cbf36 100644 --- a/classes/v1.UsageAttributionPagination.html +++ b/classes/v1.UsageAttributionPagination.html @@ -1,13 +1,13 @@ UsageAttributionPagination | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAttributionPagination

The metadata for the current pagination.

-

Hierarchy

  • UsageAttributionPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional limit

limit?: number
+

Hierarchy

  • UsageAttributionPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional limit

limit?: number

Maximum amount of records to be returned.

-

Optional offset

offset?: number
+

Optional offset

offset?: number

Records to be skipped before beginning to return.

-

Optional sortDirection

sortDirection?: string
+

Optional sortDirection

sortDirection?: string

Direction to sort by.

-

Optional sortName

sortName?: string
+

Optional sortName

sortName?: string

Field to sort by.

-

Optional totalNumberOfRecords

totalNumberOfRecords?: number
+

Optional totalNumberOfRecords

totalNumberOfRecords?: number

Total number of records.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAttributionResponse.html b/classes/v1.UsageAttributionResponse.html index 26ce980d1ff..0025206cbb1 100644 --- a/classes/v1.UsageAttributionResponse.html +++ b/classes/v1.UsageAttributionResponse.html @@ -1,5 +1,5 @@ UsageAttributionResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAttributionResponse

Response containing the Usage Summary by tag(s).

-

Hierarchy

  • UsageAttributionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: UsageAttributionMetadata

Optional usage

usage?: UsageAttributionBody[]
+

Hierarchy

  • UsageAttributionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: UsageAttributionMetadata

Optional usage

usage?: UsageAttributionBody[]

Get Usage Summary by tag(s).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAttributionValues.html b/classes/v1.UsageAttributionValues.html index 96fd8dbc40b..bd3ef2f5687 100644 --- a/classes/v1.UsageAttributionValues.html +++ b/classes/v1.UsageAttributionValues.html @@ -1,83 +1,83 @@ UsageAttributionValues | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAttributionValues

Fields in Usage Summary by tag(s).

-

Hierarchy

  • UsageAttributionValues

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiPercentage

apiPercentage?: number
+

Hierarchy

  • UsageAttributionValues

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiPercentage

apiPercentage?: number

The percentage of synthetic API test usage by tag(s).

-

Optional apiUsage

apiUsage?: number
+

Optional apiUsage

apiUsage?: number

The synthetic API test usage by tag(s).

-

Optional apmHostPercentage

apmHostPercentage?: number
+

Optional apmHostPercentage

apmHostPercentage?: number

The percentage of APM host usage by tag(s).

-

Optional apmHostUsage

apmHostUsage?: number
+

Optional apmHostUsage

apmHostUsage?: number

The APM host usage by tag(s).

-

Optional browserPercentage

browserPercentage?: number
+

Optional browserPercentage

browserPercentage?: number

The percentage of synthetic browser test usage by tag(s).

-

Optional browserUsage

browserUsage?: number
+

Optional browserUsage

browserUsage?: number

The synthetic browser test usage by tag(s).

-

Optional containerPercentage

containerPercentage?: number
+

Optional containerPercentage

containerPercentage?: number

The percentage of container usage by tag(s).

-

Optional containerUsage

containerUsage?: number
+

Optional containerUsage

containerUsage?: number

The container usage by tag(s).

-

Optional cspmContainerPercentage

cspmContainerPercentage?: number
+

Optional cspmContainerPercentage

cspmContainerPercentage?: number

The percentage of Cloud Security Posture Management container usage by tag(s)

-

Optional cspmContainerUsage

cspmContainerUsage?: number
+

Optional cspmContainerUsage

cspmContainerUsage?: number

The Cloud Security Posture Management container usage by tag(s)

-

Optional cspmHostPercentage

cspmHostPercentage?: number
+

Optional cspmHostPercentage

cspmHostPercentage?: number

The percentage of Cloud Security Posture Management host usage by tag(s)

-

Optional cspmHostUsage

cspmHostUsage?: number
+

Optional cspmHostUsage

cspmHostUsage?: number

The Cloud Security Posture Management host usage by tag(s)

-

Optional customTimeseriesPercentage

customTimeseriesPercentage?: number
+

Optional customTimeseriesPercentage

customTimeseriesPercentage?: number

The percentage of custom metrics usage by tag(s).

-

Optional customTimeseriesUsage

customTimeseriesUsage?: number
+

Optional customTimeseriesUsage

customTimeseriesUsage?: number

The custom metrics usage by tag(s).

-

Optional cwsContainerPercentage

cwsContainerPercentage?: number
+

Optional cwsContainerPercentage

cwsContainerPercentage?: number

The percentage of Cloud Workload Security container usage by tag(s)

-

Optional cwsContainerUsage

cwsContainerUsage?: number
+

Optional cwsContainerUsage

cwsContainerUsage?: number

The Cloud Workload Security container usage by tag(s)

-

Optional cwsHostPercentage

cwsHostPercentage?: number
+

Optional cwsHostPercentage

cwsHostPercentage?: number

The percentage of Cloud Workload Security host usage by tag(s)

-

Optional cwsHostUsage

cwsHostUsage?: number
+

Optional cwsHostUsage

cwsHostUsage?: number

The Cloud Workload Security host usage by tag(s)

-

Optional dbmHostsPercentage

dbmHostsPercentage?: number
+

Optional dbmHostsPercentage

dbmHostsPercentage?: number

The percentage of Database Monitoring host usage by tag(s).

-

Optional dbmHostsUsage

dbmHostsUsage?: number
+

Optional dbmHostsUsage

dbmHostsUsage?: number

The Database Monitoring host usage by tag(s).

-

Optional dbmQueriesPercentage

dbmQueriesPercentage?: number
+

Optional dbmQueriesPercentage

dbmQueriesPercentage?: number

The percentage of Database Monitoring normalized queries usage by tag(s).

-

Optional dbmQueriesUsage

dbmQueriesUsage?: number
+

Optional dbmQueriesUsage

dbmQueriesUsage?: number

The Database Monitoring normalized queries usage by tag(s).

-

Optional estimatedIndexedLogsPercentage

estimatedIndexedLogsPercentage?: number
+

Optional estimatedIndexedLogsPercentage

estimatedIndexedLogsPercentage?: number

The percentage of estimated live indexed logs usage by tag(s). Note this field is in private beta.

-

Optional estimatedIndexedLogsUsage

estimatedIndexedLogsUsage?: number
+

Optional estimatedIndexedLogsUsage

estimatedIndexedLogsUsage?: number

The estimated live indexed logs usage by tag(s). Note this field is in private beta.

-

Optional infraHostPercentage

infraHostPercentage?: number
+

Optional infraHostPercentage

infraHostPercentage?: number

The percentage of infrastructure host usage by tag(s).

-

Optional infraHostUsage

infraHostUsage?: number
+

Optional infraHostUsage

infraHostUsage?: number

The infrastructure host usage by tag(s).

-

Optional lambdaFunctionsPercentage

lambdaFunctionsPercentage?: number
+

Optional lambdaFunctionsPercentage

lambdaFunctionsPercentage?: number

The percentage of Lambda function usage by tag(s).

-

Optional lambdaFunctionsUsage

lambdaFunctionsUsage?: number
+

Optional lambdaFunctionsUsage

lambdaFunctionsUsage?: number

The Lambda function usage by tag(s).

-

Optional lambdaInvocationsPercentage

lambdaInvocationsPercentage?: number
+

Optional lambdaInvocationsPercentage

lambdaInvocationsPercentage?: number

The percentage of Lambda invocation usage by tag(s).

-

Optional lambdaInvocationsUsage

lambdaInvocationsUsage?: number
+

Optional lambdaInvocationsUsage

lambdaInvocationsUsage?: number

The Lambda invocation usage by tag(s).

-

Optional lambdaPercentage

lambdaPercentage?: number
+

Optional lambdaPercentage

lambdaPercentage?: number

The percentage of Lambda function usage by tag(s). Note this field is deprecated. Use lambda_functions_percentage instead.

-

Optional lambdaUsage

lambdaUsage?: number
+

Optional lambdaUsage

lambdaUsage?: number

The Lambda function usage by tag(s). Note this field is deprecated. Use lambda_functions_usage instead.

-

Optional npmHostPercentage

npmHostPercentage?: number
+

Optional npmHostPercentage

npmHostPercentage?: number

The percentage of network host usage by tag(s).

-

Optional npmHostUsage

npmHostUsage?: number
+

Optional npmHostUsage

npmHostUsage?: number

The network host usage by tag(s).

-

Optional profiledContainerPercentage

profiledContainerPercentage?: number
+

Optional profiledContainerPercentage

profiledContainerPercentage?: number

The percentage of profiled containers usage by tag(s).

-

Optional profiledContainerUsage

profiledContainerUsage?: number
+

Optional profiledContainerUsage

profiledContainerUsage?: number

The profiled container usage by tag(s).

-

Optional profiledHostsPercentage

profiledHostsPercentage?: number
+

Optional profiledHostsPercentage

profiledHostsPercentage?: number

The percentage of profiled hosts usage by tag(s).

-

Optional profiledHostsUsage

profiledHostsUsage?: number
+

Optional profiledHostsUsage

profiledHostsUsage?: number

The profiled host usage by tag(s).

-

Optional snmpPercentage

snmpPercentage?: number
+

Optional snmpPercentage

snmpPercentage?: number

The percentage of network device usage by tag(s).

-

Optional snmpUsage

snmpUsage?: number
+

Optional snmpUsage

snmpUsage?: number

The network device usage by tag(s).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAuditLogsHour.html b/classes/v1.UsageAuditLogsHour.html index d3416fd9c47..41715dcaf2f 100644 --- a/classes/v1.UsageAuditLogsHour.html +++ b/classes/v1.UsageAuditLogsHour.html @@ -1,11 +1,11 @@ UsageAuditLogsHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAuditLogsHour

Audit logs usage for a given organization for a given hour.

-

Hierarchy

  • UsageAuditLogsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date
+

Hierarchy

  • UsageAuditLogsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date

The hour for the usage.

-

Optional linesIndexed

linesIndexed?: number
+

Optional linesIndexed

linesIndexed?: number

The total number of audit logs lines indexed during a given hour.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageAuditLogsResponse.html b/classes/v1.UsageAuditLogsResponse.html index 615903f5564..a384ce5ea9b 100644 --- a/classes/v1.UsageAuditLogsResponse.html +++ b/classes/v1.UsageAuditLogsResponse.html @@ -1,5 +1,5 @@ UsageAuditLogsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageAuditLogsResponse

Response containing the audit logs usage for each hour for a given organization.

-

Hierarchy

  • UsageAuditLogsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageAuditLogsHour[]
+

Hierarchy

  • UsageAuditLogsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageAuditLogsHour[]

Get hourly usage for audit logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageBillableSummaryBody.html b/classes/v1.UsageBillableSummaryBody.html index c7f83f3a5f5..5beabc3f654 100644 --- a/classes/v1.UsageBillableSummaryBody.html +++ b/classes/v1.UsageBillableSummaryBody.html @@ -1,17 +1,17 @@ UsageBillableSummaryBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageBillableSummaryBody

Response with properties for each aggregated usage type.

-

Hierarchy

  • UsageBillableSummaryBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountBillableUsage

accountBillableUsage?: number
+

Hierarchy

  • UsageBillableSummaryBody

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accountBillableUsage

accountBillableUsage?: number

The total account usage.

-

Optional elapsedUsageHours

elapsedUsageHours?: number
+

Optional elapsedUsageHours

elapsedUsageHours?: number

Elapsed usage hours for some billable product.

-

Optional firstBillableUsageHour

firstBillableUsageHour?: Date
+

Optional firstBillableUsageHour

firstBillableUsageHour?: Date

The first billable hour for the org.

-

Optional lastBillableUsageHour

lastBillableUsageHour?: Date
+

Optional lastBillableUsageHour

lastBillableUsageHour?: Date

The last billable hour for the org.

-

Optional orgBillableUsage

orgBillableUsage?: number
+

Optional orgBillableUsage

orgBillableUsage?: number

The number of units used within the billable timeframe.

-

Optional percentageInAccount

percentageInAccount?: number
+

Optional percentageInAccount

percentageInAccount?: number

The percentage of account usage the org represents.

-

Optional usageUnit

usageUnit?: string
+

Optional usageUnit

usageUnit?: string

Units pertaining to the usage.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageBillableSummaryHour.html b/classes/v1.UsageBillableSummaryHour.html index 8cd80ccf022..b7af704357e 100644 --- a/classes/v1.UsageBillableSummaryHour.html +++ b/classes/v1.UsageBillableSummaryHour.html @@ -1,17 +1,17 @@ UsageBillableSummaryHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageBillableSummaryHour

Response with monthly summary of data billed by Datadog.

-

Hierarchy

  • UsageBillableSummaryHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billingPlan

billingPlan?: string
+

Hierarchy

  • UsageBillableSummaryHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billingPlan

billingPlan?: string

The billing plan.

-

Optional endDate

endDate?: Date
+

Optional endDate

endDate?: Date

Shows the last date of usage.

-

Optional numOrgs

numOrgs?: number
+

Optional numOrgs

numOrgs?: number

The number of organizations.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

-

Optional ratioInMonth

ratioInMonth?: number
+

Optional ratioInMonth

ratioInMonth?: number

Shows usage aggregation for a billing period.

-

Optional startDate

startDate?: Date
+

Optional startDate

startDate?: Date

Shows the first date of usage.

-

Optional usage

usage?: UsageBillableSummaryKeys

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional usage

usage?: UsageBillableSummaryKeys

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageBillableSummaryKeys.html b/classes/v1.UsageBillableSummaryKeys.html index 1d3227394f6..dbf8b2ef0e7 100644 --- a/classes/v1.UsageBillableSummaryKeys.html +++ b/classes/v1.UsageBillableSummaryKeys.html @@ -1,3 +1,3 @@ UsageBillableSummaryKeys | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageBillableSummaryKeys

Response with aggregated usage types.

-

Hierarchy

  • UsageBillableSummaryKeys

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmHostSum

apmHostSum?: UsageBillableSummaryBody

Optional apmHostTop99p

apmHostTop99p?: UsageBillableSummaryBody

Optional apmTraceSearchSum

apmTraceSearchSum?: UsageBillableSummaryBody

Optional fargateContainerAverage

fargateContainerAverage?: UsageBillableSummaryBody

Optional infraContainerSum

infraContainerSum?: UsageBillableSummaryBody

Optional infraHostSum

infraHostSum?: UsageBillableSummaryBody

Optional infraHostTop99p

infraHostTop99p?: UsageBillableSummaryBody

Optional iotTop99p

iotTop99p?: UsageBillableSummaryBody

Optional lambdaFunctionAverage

lambdaFunctionAverage?: UsageBillableSummaryBody

Optional logsIndexed15daySum

logsIndexed15daySum?: UsageBillableSummaryBody

Optional logsIndexed180daySum

logsIndexed180daySum?: UsageBillableSummaryBody

Optional logsIndexed30daySum

logsIndexed30daySum?: UsageBillableSummaryBody

Optional logsIndexed3daySum

logsIndexed3daySum?: UsageBillableSummaryBody

Optional logsIndexed45daySum

logsIndexed45daySum?: UsageBillableSummaryBody

Optional logsIndexed60daySum

logsIndexed60daySum?: UsageBillableSummaryBody

Optional logsIndexed7daySum

logsIndexed7daySum?: UsageBillableSummaryBody

Optional logsIndexed90daySum

logsIndexed90daySum?: UsageBillableSummaryBody

Optional logsIndexedCustomRetentionSum

logsIndexedCustomRetentionSum?: UsageBillableSummaryBody

Optional logsIndexedSum

logsIndexedSum?: UsageBillableSummaryBody

Optional logsIngestedSum

logsIngestedSum?: UsageBillableSummaryBody

Optional networkDeviceTop99p

networkDeviceTop99p?: UsageBillableSummaryBody

Optional npmFlowSum

npmFlowSum?: UsageBillableSummaryBody

Optional npmHostSum

npmHostSum?: UsageBillableSummaryBody

Optional npmHostTop99p

npmHostTop99p?: UsageBillableSummaryBody

Optional profContainerSum

profContainerSum?: UsageBillableSummaryBody

Optional profHostTop99p

profHostTop99p?: UsageBillableSummaryBody

Optional rumSum

rumSum?: UsageBillableSummaryBody

Optional serverlessInvocationSum

serverlessInvocationSum?: UsageBillableSummaryBody

Optional siemSum

siemSum?: UsageBillableSummaryBody

Optional syntheticsApiTestsSum

syntheticsApiTestsSum?: UsageBillableSummaryBody

Optional syntheticsBrowserChecksSum

syntheticsBrowserChecksSum?: UsageBillableSummaryBody

Optional timeseriesAverage

timeseriesAverage?: UsageBillableSummaryBody

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UsageBillableSummaryKeys

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmHostSum

apmHostSum?: UsageBillableSummaryBody

Optional apmHostTop99p

apmHostTop99p?: UsageBillableSummaryBody

Optional apmTraceSearchSum

apmTraceSearchSum?: UsageBillableSummaryBody

Optional fargateContainerAverage

fargateContainerAverage?: UsageBillableSummaryBody

Optional infraContainerSum

infraContainerSum?: UsageBillableSummaryBody

Optional infraHostSum

infraHostSum?: UsageBillableSummaryBody

Optional infraHostTop99p

infraHostTop99p?: UsageBillableSummaryBody

Optional iotTop99p

iotTop99p?: UsageBillableSummaryBody

Optional lambdaFunctionAverage

lambdaFunctionAverage?: UsageBillableSummaryBody

Optional logsIndexed15daySum

logsIndexed15daySum?: UsageBillableSummaryBody

Optional logsIndexed180daySum

logsIndexed180daySum?: UsageBillableSummaryBody

Optional logsIndexed30daySum

logsIndexed30daySum?: UsageBillableSummaryBody

Optional logsIndexed3daySum

logsIndexed3daySum?: UsageBillableSummaryBody

Optional logsIndexed45daySum

logsIndexed45daySum?: UsageBillableSummaryBody

Optional logsIndexed60daySum

logsIndexed60daySum?: UsageBillableSummaryBody

Optional logsIndexed7daySum

logsIndexed7daySum?: UsageBillableSummaryBody

Optional logsIndexed90daySum

logsIndexed90daySum?: UsageBillableSummaryBody

Optional logsIndexedCustomRetentionSum

logsIndexedCustomRetentionSum?: UsageBillableSummaryBody

Optional logsIndexedSum

logsIndexedSum?: UsageBillableSummaryBody

Optional logsIngestedSum

logsIngestedSum?: UsageBillableSummaryBody

Optional networkDeviceTop99p

networkDeviceTop99p?: UsageBillableSummaryBody

Optional npmFlowSum

npmFlowSum?: UsageBillableSummaryBody

Optional npmHostSum

npmHostSum?: UsageBillableSummaryBody

Optional npmHostTop99p

npmHostTop99p?: UsageBillableSummaryBody

Optional profContainerSum

profContainerSum?: UsageBillableSummaryBody

Optional profHostTop99p

profHostTop99p?: UsageBillableSummaryBody

Optional rumSum

rumSum?: UsageBillableSummaryBody

Optional serverlessInvocationSum

serverlessInvocationSum?: UsageBillableSummaryBody

Optional siemSum

siemSum?: UsageBillableSummaryBody

Optional syntheticsApiTestsSum

syntheticsApiTestsSum?: UsageBillableSummaryBody

Optional syntheticsBrowserChecksSum

syntheticsBrowserChecksSum?: UsageBillableSummaryBody

Optional timeseriesAverage

timeseriesAverage?: UsageBillableSummaryBody

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageBillableSummaryResponse.html b/classes/v1.UsageBillableSummaryResponse.html index df31cbbdf84..af52621a8bb 100644 --- a/classes/v1.UsageBillableSummaryResponse.html +++ b/classes/v1.UsageBillableSummaryResponse.html @@ -1,5 +1,5 @@ UsageBillableSummaryResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageBillableSummaryResponse

Response with monthly summary of data billed by Datadog.

-

Hierarchy

  • UsageBillableSummaryResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageBillableSummaryHour[]
+

Hierarchy

  • UsageBillableSummaryResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageBillableSummaryHour[]

An array of objects regarding usage of billable summary.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCWSHour.html b/classes/v1.UsageCWSHour.html index 1d233089acb..f1bb49a17b9 100644 --- a/classes/v1.UsageCWSHour.html +++ b/classes/v1.UsageCWSHour.html @@ -1,13 +1,13 @@ UsageCWSHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCWSHour

Cloud Workload Security usage for a given organization for a given hour.

-

Hierarchy

  • UsageCWSHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cwsContainerCount

cwsContainerCount?: number
+

Hierarchy

  • UsageCWSHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cwsContainerCount

cwsContainerCount?: number

The total number of Cloud Workload Security container hours from the start of the given hour’s month until the given hour.

-

Optional cwsHostCount

cwsHostCount?: number
+

Optional cwsHostCount

cwsHostCount?: number

The total number of Cloud Workload Security host hours from the start of the given hour’s month until the given hour.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCWSResponse.html b/classes/v1.UsageCWSResponse.html index f4acd460311..8970308ceed 100644 --- a/classes/v1.UsageCWSResponse.html +++ b/classes/v1.UsageCWSResponse.html @@ -1,5 +1,5 @@ UsageCWSResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCWSResponse

Response containing the Cloud Workload Security usage for each hour for a given organization.

-

Hierarchy

  • UsageCWSResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageCWSHour[]
+

Hierarchy

  • UsageCWSResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageCWSHour[]

Get hourly usage for Cloud Workload Security.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCloudSecurityPostureManagementHour.html b/classes/v1.UsageCloudSecurityPostureManagementHour.html index 0624f8e3e05..d22a57deb6e 100644 --- a/classes/v1.UsageCloudSecurityPostureManagementHour.html +++ b/classes/v1.UsageCloudSecurityPostureManagementHour.html @@ -1,19 +1,19 @@ UsageCloudSecurityPostureManagementHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCloudSecurityPostureManagementHour

Cloud Security Posture Management usage for a given organization for a given hour.

-

Hierarchy

  • UsageCloudSecurityPostureManagementHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aasHostCount

aasHostCount?: number
+

Hierarchy

  • UsageCloudSecurityPostureManagementHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aasHostCount

aasHostCount?: number

The number of Cloud Security Posture Management Azure app services hosts during a given hour.

-

Optional azureHostCount

azureHostCount?: number
+

Optional azureHostCount

azureHostCount?: number

The number of Cloud Security Posture Management Azure hosts during a given hour.

-

Optional complianceHostCount

complianceHostCount?: number
+

Optional complianceHostCount

complianceHostCount?: number

The number of Cloud Security Posture Management hosts during a given hour.

-

Optional containerCount

containerCount?: number
+

Optional containerCount

containerCount?: number

The total number of Cloud Security Posture Management containers during a given hour.

-

Optional hostCount

hostCount?: number
+

Optional hostCount

hostCount?: number

The total number of Cloud Security Posture Management hosts during a given hour.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCloudSecurityPostureManagementResponse.html b/classes/v1.UsageCloudSecurityPostureManagementResponse.html index b65f6563d5e..44f3297f381 100644 --- a/classes/v1.UsageCloudSecurityPostureManagementResponse.html +++ b/classes/v1.UsageCloudSecurityPostureManagementResponse.html @@ -1,5 +1,5 @@ UsageCloudSecurityPostureManagementResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCloudSecurityPostureManagementResponse

The response containing the Cloud Security Posture Management usage for each hour for a given organization.

-

Hierarchy

  • UsageCloudSecurityPostureManagementResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageCloudSecurityPostureManagementHour[]
+

Hierarchy

  • UsageCloudSecurityPostureManagementResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageCloudSecurityPostureManagementHour[]

Get hourly usage for Cloud Security Posture Management.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCustomReportsAttributes.html b/classes/v1.UsageCustomReportsAttributes.html index bb39f636807..d64e0367460 100644 --- a/classes/v1.UsageCustomReportsAttributes.html +++ b/classes/v1.UsageCustomReportsAttributes.html @@ -1,13 +1,13 @@ UsageCustomReportsAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCustomReportsAttributes

The response containing attributes for custom reports.

-

Hierarchy

  • UsageCustomReportsAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional computedOn

computedOn?: string
+

Hierarchy

  • UsageCustomReportsAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional computedOn

computedOn?: string

The date the specified custom report was computed.

-

Optional endDate

endDate?: string
+

Optional endDate

endDate?: string

The ending date of custom report.

-

Optional size

size?: number
+

Optional size

size?: number

size

-

Optional startDate

startDate?: string
+

Optional startDate

startDate?: string

The starting date of custom report.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

A list of tags to apply to custom reports.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCustomReportsData.html b/classes/v1.UsageCustomReportsData.html index 9d8ab7af013..c2465a9ac3e 100644 --- a/classes/v1.UsageCustomReportsData.html +++ b/classes/v1.UsageCustomReportsData.html @@ -1,5 +1,5 @@ UsageCustomReportsData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCustomReportsData

The response containing the date and type for custom reports.

-

Hierarchy

  • UsageCustomReportsData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: UsageCustomReportsAttributes

Optional id

id?: string
+

Hierarchy

  • UsageCustomReportsData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: UsageCustomReportsAttributes

Optional id

id?: string

The date for specified custom reports.

-

Optional type

type?: "reports"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "reports"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCustomReportsMeta.html b/classes/v1.UsageCustomReportsMeta.html index 6fe6078e9c5..a9d8934de73 100644 --- a/classes/v1.UsageCustomReportsMeta.html +++ b/classes/v1.UsageCustomReportsMeta.html @@ -1,3 +1,3 @@ UsageCustomReportsMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCustomReportsMeta

The object containing document metadata.

-

Hierarchy

  • UsageCustomReportsMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: UsageCustomReportsPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UsageCustomReportsMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: UsageCustomReportsPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCustomReportsPage.html b/classes/v1.UsageCustomReportsPage.html index fd6b9d13e0d..82435c7902f 100644 --- a/classes/v1.UsageCustomReportsPage.html +++ b/classes/v1.UsageCustomReportsPage.html @@ -1,5 +1,5 @@ UsageCustomReportsPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCustomReportsPage

The object containing page total count.

-

Hierarchy

  • UsageCustomReportsPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number
+

Hierarchy

  • UsageCustomReportsPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number

Total page count.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageCustomReportsResponse.html b/classes/v1.UsageCustomReportsResponse.html index 23b09e2bd6b..1d7f09c2ac6 100644 --- a/classes/v1.UsageCustomReportsResponse.html +++ b/classes/v1.UsageCustomReportsResponse.html @@ -1,5 +1,5 @@ UsageCustomReportsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageCustomReportsResponse

Response containing available custom reports.

-

Hierarchy

  • UsageCustomReportsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UsageCustomReportsData[]
+

Hierarchy

  • UsageCustomReportsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UsageCustomReportsData[]

An array of available custom reports.

-

Optional meta

meta?: UsageCustomReportsMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional meta

meta?: UsageCustomReportsMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageDBMHour.html b/classes/v1.UsageDBMHour.html index 6300f2c4438..ac66fc7b180 100644 --- a/classes/v1.UsageDBMHour.html +++ b/classes/v1.UsageDBMHour.html @@ -1,13 +1,13 @@ UsageDBMHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageDBMHour

Database Monitoring usage for a given organization for a given hour.

-

Hierarchy

  • UsageDBMHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dbmHostCount

dbmHostCount?: number
+

Hierarchy

  • UsageDBMHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dbmHostCount

dbmHostCount?: number

The total number of Database Monitoring host hours from the start of the given hour’s month until the given hour.

-

Optional dbmQueriesCount

dbmQueriesCount?: number
+

Optional dbmQueriesCount

dbmQueriesCount?: number

The total number of normalized Database Monitoring queries from the start of the given hour’s month until the given hour.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageDBMResponse.html b/classes/v1.UsageDBMResponse.html index 8d25f6557dd..29e65aa052a 100644 --- a/classes/v1.UsageDBMResponse.html +++ b/classes/v1.UsageDBMResponse.html @@ -1,5 +1,5 @@ UsageDBMResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageDBMResponse

Response containing the Database Monitoring usage for each hour for a given organization.

-

Hierarchy

  • UsageDBMResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageDBMHour[]
+

Hierarchy

  • UsageDBMResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageDBMHour[]

Get hourly usage for Database Monitoring

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageFargateHour.html b/classes/v1.UsageFargateHour.html index 92c92924676..d2f99369f40 100644 --- a/classes/v1.UsageFargateHour.html +++ b/classes/v1.UsageFargateHour.html @@ -1,13 +1,13 @@ UsageFargateHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageFargateHour

Number of Fargate tasks run and hourly usage.

-

Hierarchy

  • UsageFargateHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional avgProfiledFargateTasks

avgProfiledFargateTasks?: number
+

Hierarchy

  • UsageFargateHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional avgProfiledFargateTasks

avgProfiledFargateTasks?: number

The average profiled task count for Fargate Profiling.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

-

Optional tasksCount

tasksCount?: number
+

Optional tasksCount

tasksCount?: number

The number of Fargate tasks run.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageFargateResponse.html b/classes/v1.UsageFargateResponse.html index 69b3118bfba..027e8ff4c5f 100644 --- a/classes/v1.UsageFargateResponse.html +++ b/classes/v1.UsageFargateResponse.html @@ -1,5 +1,5 @@ UsageFargateResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageFargateResponse

Response containing the number of Fargate tasks run and hourly usage.

-

Hierarchy

  • UsageFargateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageFargateHour[]
+

Hierarchy

  • UsageFargateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageFargateHour[]

Array with the number of hourly Fargate tasks recorded for a given organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageHostHour.html b/classes/v1.UsageHostHour.html index 177323d6d43..6880819dc83 100644 --- a/classes/v1.UsageHostHour.html +++ b/classes/v1.UsageHostHour.html @@ -1,35 +1,35 @@ UsageHostHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageHostHour

Number of hosts/containers recorded for each hour for a given organization.

-

Hierarchy

  • UsageHostHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostCount

agentHostCount?: number
+

Hierarchy

  • UsageHostHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostCount

agentHostCount?: number

Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent.

-

Optional alibabaHostCount

alibabaHostCount?: number
+

Optional alibabaHostCount

alibabaHostCount?: number

Contains the total number of hosts that reported through Alibaba integration (and were NOT running the Datadog Agent).

-

Optional apmAzureAppServiceHostCount

apmAzureAppServiceHostCount?: number
+

Optional apmAzureAppServiceHostCount

apmAzureAppServiceHostCount?: number

Contains the total number of Azure App Services hosts using APM.

-

Optional apmHostCount

apmHostCount?: number
+

Optional apmHostCount

apmHostCount?: number

Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods).

-

Optional awsHostCount

awsHostCount?: number
+

Optional awsHostCount

awsHostCount?: number

Contains the total number of hosts that reported through the AWS integration (and were NOT running the Datadog Agent).

-

Optional azureHostCount

azureHostCount?: number
+

Optional azureHostCount

azureHostCount?: number

Contains the total number of hosts that reported through Azure integration (and were NOT running the Datadog Agent).

-

Optional containerCount

containerCount?: number
+

Optional containerCount

containerCount?: number

Shows the total number of containers reported by the Docker integration during the hour.

-

Optional gcpHostCount

gcpHostCount?: number
+

Optional gcpHostCount

gcpHostCount?: number

Contains the total number of hosts that reported through the Google Cloud integration (and were NOT running the Datadog Agent).

-

Optional herokuHostCount

herokuHostCount?: number
+

Optional herokuHostCount

herokuHostCount?: number

Contains the total number of Heroku dynos reported by the Datadog Agent.

-

Optional hostCount

hostCount?: number
+

Optional hostCount

hostCount?: number

Contains the total number of billable infrastructure hosts reporting during a given hour. This is the sum of agent_host_count, aws_host_count, and gcp_host_count.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional infraAzureAppService

infraAzureAppService?: number
+

Optional infraAzureAppService

infraAzureAppService?: number

Contains the total number of hosts that reported through the Azure App Services integration (and were NOT running the Datadog Agent).

-

Optional opentelemetryHostCount

opentelemetryHostCount?: number
+

Optional opentelemetryHostCount

opentelemetryHostCount?: number

Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

-

Optional vsphereHostCount

vsphereHostCount?: number
+

Optional vsphereHostCount

vsphereHostCount?: number

Contains the total number of hosts that reported through vSphere integration (and were NOT running the Datadog Agent).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageHostsResponse.html b/classes/v1.UsageHostsResponse.html index 50afbd197e9..9e8385e0a09 100644 --- a/classes/v1.UsageHostsResponse.html +++ b/classes/v1.UsageHostsResponse.html @@ -1,5 +1,5 @@ UsageHostsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageHostsResponse

Host usage response.

-

Hierarchy

  • UsageHostsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageHostHour[]
+

Hierarchy

  • UsageHostsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageHostHour[]

An array of objects related to host usage.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIncidentManagementHour.html b/classes/v1.UsageIncidentManagementHour.html index 3995695c148..dd74b0a5b9c 100644 --- a/classes/v1.UsageIncidentManagementHour.html +++ b/classes/v1.UsageIncidentManagementHour.html @@ -1,11 +1,11 @@ UsageIncidentManagementHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIncidentManagementHour

Incident management usage for a given organization for a given hour.

-

Hierarchy

  • UsageIncidentManagementHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date
+

Hierarchy

  • UsageIncidentManagementHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date

The hour for the usage.

-

Optional monthlyActiveUsers

monthlyActiveUsers?: number
+

Optional monthlyActiveUsers

monthlyActiveUsers?: number

Contains the total number monthly active users from the start of the given hour's month until the given hour.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIncidentManagementResponse.html b/classes/v1.UsageIncidentManagementResponse.html index 6e56b462482..611bfa2fc47 100644 --- a/classes/v1.UsageIncidentManagementResponse.html +++ b/classes/v1.UsageIncidentManagementResponse.html @@ -1,5 +1,5 @@ UsageIncidentManagementResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIncidentManagementResponse

Response containing the incident management usage for each hour for a given organization.

-

Hierarchy

  • UsageIncidentManagementResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIncidentManagementHour[]
+

Hierarchy

  • UsageIncidentManagementResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIncidentManagementHour[]

Get hourly usage for incident management.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIndexedSpansHour.html b/classes/v1.UsageIndexedSpansHour.html index dd30f84c0b4..4be278704a3 100644 --- a/classes/v1.UsageIndexedSpansHour.html +++ b/classes/v1.UsageIndexedSpansHour.html @@ -1,11 +1,11 @@ UsageIndexedSpansHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIndexedSpansHour

The hours of indexed spans usage.

-

Hierarchy

  • UsageIndexedSpansHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date
+

Hierarchy

  • UsageIndexedSpansHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date

The hour for the usage.

-

Optional indexedEventsCount

indexedEventsCount?: number
+

Optional indexedEventsCount

indexedEventsCount?: number

Contains the number of spans indexed.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIndexedSpansResponse.html b/classes/v1.UsageIndexedSpansResponse.html index 11d0552f1ed..bbe2d099f0b 100644 --- a/classes/v1.UsageIndexedSpansResponse.html +++ b/classes/v1.UsageIndexedSpansResponse.html @@ -1,5 +1,5 @@ UsageIndexedSpansResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIndexedSpansResponse

A response containing indexed spans usage.

-

Hierarchy

  • UsageIndexedSpansResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIndexedSpansHour[]
+

Hierarchy

  • UsageIndexedSpansResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIndexedSpansHour[]

Array with the number of hourly traces indexed for a given organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIngestedSpansHour.html b/classes/v1.UsageIngestedSpansHour.html index 20d2fac7e0e..6e891a834d3 100644 --- a/classes/v1.UsageIngestedSpansHour.html +++ b/classes/v1.UsageIngestedSpansHour.html @@ -1,11 +1,11 @@ UsageIngestedSpansHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIngestedSpansHour

Ingested spans usage for a given organization for a given hour.

-

Hierarchy

  • UsageIngestedSpansHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date
+

Hierarchy

  • UsageIngestedSpansHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date

The hour for the usage.

-

Optional ingestedEventsBytes

ingestedEventsBytes?: number
+

Optional ingestedEventsBytes

ingestedEventsBytes?: number

Contains the total number of bytes ingested during a given hour.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIngestedSpansResponse.html b/classes/v1.UsageIngestedSpansResponse.html index 55a612e0400..2abd4f27b69 100644 --- a/classes/v1.UsageIngestedSpansResponse.html +++ b/classes/v1.UsageIngestedSpansResponse.html @@ -1,5 +1,5 @@ UsageIngestedSpansResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIngestedSpansResponse

Response containing the ingested spans usage for each hour for a given organization.

-

Hierarchy

  • UsageIngestedSpansResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIngestedSpansHour[]
+

Hierarchy

  • UsageIngestedSpansResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIngestedSpansHour[]

Get hourly usage for ingested spans.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIoTHour.html b/classes/v1.UsageIoTHour.html index f5bc9cae82e..b3ce30779c8 100644 --- a/classes/v1.UsageIoTHour.html +++ b/classes/v1.UsageIoTHour.html @@ -1,11 +1,11 @@ UsageIoTHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIoTHour

IoT usage for a given organization for a given hour.

-

Hierarchy

  • UsageIoTHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date
+

Hierarchy

  • UsageIoTHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date

The hour for the usage.

-

Optional iotDeviceCount

iotDeviceCount?: number
+

Optional iotDeviceCount

iotDeviceCount?: number

The total number of IoT devices during a given hour.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageIoTResponse.html b/classes/v1.UsageIoTResponse.html index 3eecd1cb026..d1b1762d7dd 100644 --- a/classes/v1.UsageIoTResponse.html +++ b/classes/v1.UsageIoTResponse.html @@ -1,5 +1,5 @@ UsageIoTResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageIoTResponse

Response containing the IoT usage for each hour for a given organization.

-

Hierarchy

  • UsageIoTResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIoTHour[]
+

Hierarchy

  • UsageIoTResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageIoTHour[]

Get hourly usage for IoT.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLambdaHour.html b/classes/v1.UsageLambdaHour.html index 702e6687c46..9f20144f3d4 100644 --- a/classes/v1.UsageLambdaHour.html +++ b/classes/v1.UsageLambdaHour.html @@ -1,13 +1,13 @@ UsageLambdaHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLambdaHour

Number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.

-

Hierarchy

  • UsageLambdaHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional funcCount

funcCount?: number
+

Hierarchy

  • UsageLambdaHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional funcCount

funcCount?: number

Contains the number of different functions for each region and AWS account.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional invocationsSum

invocationsSum?: number
+

Optional invocationsSum

invocationsSum?: number

Contains the sum of invocations of all functions.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLambdaResponse.html b/classes/v1.UsageLambdaResponse.html index a87860d5dd5..ada606d9faf 100644 --- a/classes/v1.UsageLambdaResponse.html +++ b/classes/v1.UsageLambdaResponse.html @@ -1,5 +1,5 @@ UsageLambdaResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLambdaResponse

Response containing the number of lambda functions and sum of the invocations of all lambda functions for each hour for a given organization.

-

Hierarchy

  • UsageLambdaResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLambdaHour[]
+

Hierarchy

  • UsageLambdaResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLambdaHour[]

Get hourly usage for Lambda.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLogsByIndexHour.html b/classes/v1.UsageLogsByIndexHour.html index 2bd8d34204e..47e721a2b9c 100644 --- a/classes/v1.UsageLogsByIndexHour.html +++ b/classes/v1.UsageLogsByIndexHour.html @@ -1,17 +1,17 @@ UsageLogsByIndexHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLogsByIndexHour

Number of indexed logs for each hour and index for a given organization.

-

Hierarchy

  • UsageLogsByIndexHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional eventCount

eventCount?: number
+

Hierarchy

  • UsageLogsByIndexHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional eventCount

eventCount?: number

The total number of indexed logs for the queried hour.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional indexId

indexId?: string
+

Optional indexId

indexId?: string

The index ID for this usage.

-

Optional indexName

indexName?: string
+

Optional indexName

indexName?: string

The user specified name for this index ID.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

-

Optional retention

retention?: number
+

Optional retention

retention?: number

The retention period (in days) for this index ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLogsByIndexResponse.html b/classes/v1.UsageLogsByIndexResponse.html index 3b8f86950f5..c2e9b093e42 100644 --- a/classes/v1.UsageLogsByIndexResponse.html +++ b/classes/v1.UsageLogsByIndexResponse.html @@ -1,5 +1,5 @@ UsageLogsByIndexResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLogsByIndexResponse

Response containing the number of indexed logs for each hour and index for a given organization.

-

Hierarchy

  • UsageLogsByIndexResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLogsByIndexHour[]
+

Hierarchy

  • UsageLogsByIndexResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLogsByIndexHour[]

An array of objects regarding hourly usage of logs by index response.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLogsByRetentionHour.html b/classes/v1.UsageLogsByRetentionHour.html index a06b010a394..11227a14ab9 100644 --- a/classes/v1.UsageLogsByRetentionHour.html +++ b/classes/v1.UsageLogsByRetentionHour.html @@ -1,15 +1,15 @@ UsageLogsByRetentionHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLogsByRetentionHour

The number of indexed logs for each hour for a given organization broken down by retention period.

-

Hierarchy

  • UsageLogsByRetentionHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional indexedEventsCount

indexedEventsCount?: number
+

Hierarchy

  • UsageLogsByRetentionHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional indexedEventsCount

indexedEventsCount?: number

Total logs indexed with this retention period during a given hour.

-

Optional liveIndexedEventsCount

liveIndexedEventsCount?: number
+

Optional liveIndexedEventsCount

liveIndexedEventsCount?: number

Live logs indexed with this retention period during a given hour.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

-

Optional rehydratedIndexedEventsCount

rehydratedIndexedEventsCount?: number
+

Optional rehydratedIndexedEventsCount

rehydratedIndexedEventsCount?: number

Rehydrated logs indexed with this retention period during a given hour.

-

Optional retention

retention?: string
+

Optional retention

retention?: string

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

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLogsByRetentionResponse.html b/classes/v1.UsageLogsByRetentionResponse.html index f6be619f88d..9ffb03ab99c 100644 --- a/classes/v1.UsageLogsByRetentionResponse.html +++ b/classes/v1.UsageLogsByRetentionResponse.html @@ -1,5 +1,5 @@ UsageLogsByRetentionResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLogsByRetentionResponse

Response containing the indexed logs usage broken down by retention period for an organization during a given hour.

-

Hierarchy

  • UsageLogsByRetentionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLogsByRetentionHour[]
+

Hierarchy

  • UsageLogsByRetentionResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLogsByRetentionHour[]

Get hourly usage for indexed logs by retention period.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLogsHour.html b/classes/v1.UsageLogsHour.html index 84355d934e6..faa21f0f28c 100644 --- a/classes/v1.UsageLogsHour.html +++ b/classes/v1.UsageLogsHour.html @@ -1,23 +1,23 @@ UsageLogsHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLogsHour

Hour usage for logs.

-

Hierarchy

  • UsageLogsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billableIngestedBytes

billableIngestedBytes?: number
+

Hierarchy

  • UsageLogsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional billableIngestedBytes

billableIngestedBytes?: number

Contains the number of billable log bytes ingested.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional indexedEventsCount

indexedEventsCount?: number
+

Optional indexedEventsCount

indexedEventsCount?: number

Contains the number of log events indexed.

-

Optional ingestedEventsBytes

ingestedEventsBytes?: number
+

Optional ingestedEventsBytes

ingestedEventsBytes?: number

Contains the number of log bytes ingested.

-

Optional logsLiveIndexedCount

logsLiveIndexedCount?: number
+

Optional logsLiveIndexedCount

logsLiveIndexedCount?: number

Contains the number of live log events indexed (data available as of December 1, 2020).

-

Optional logsLiveIngestedBytes

logsLiveIngestedBytes?: number
+

Optional logsLiveIngestedBytes

logsLiveIngestedBytes?: number

Contains the number of live log bytes ingested (data available as of December 1, 2020).

-

Optional logsRehydratedIndexedCount

logsRehydratedIndexedCount?: number
+

Optional logsRehydratedIndexedCount

logsRehydratedIndexedCount?: number

Contains the number of rehydrated log events indexed (data available as of December 1, 2020).

-

Optional logsRehydratedIngestedBytes

logsRehydratedIngestedBytes?: number
+

Optional logsRehydratedIngestedBytes

logsRehydratedIngestedBytes?: number

Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020).

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageLogsResponse.html b/classes/v1.UsageLogsResponse.html index d6e53539a55..4034d7235d6 100644 --- a/classes/v1.UsageLogsResponse.html +++ b/classes/v1.UsageLogsResponse.html @@ -1,5 +1,5 @@ UsageLogsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageLogsResponse

Response containing the number of logs for each hour.

-

Hierarchy

  • UsageLogsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLogsHour[]
+

Hierarchy

  • UsageLogsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageLogsHour[]

An array of objects regarding hourly usage of logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageMeteringApi.html b/classes/v1.UsageMeteringApi.html index 0e1892dcf65..4b609a21b25 100644 --- a/classes/v1.UsageMeteringApi.html +++ b/classes/v1.UsageMeteringApi.html @@ -1,144 +1,144 @@ -UsageMeteringApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageMeteringApi

Hierarchy

  • UsageMeteringApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new UsageMeteringApi(configuration: v1.Configuration, requestFactory?: UsageMeteringApiRequestFactory, responseProcessor?: UsageMeteringApiResponseProcessor): UsageMeteringApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: UsageMeteringApiRequestFactory

Private responseProcessor

responseProcessor: UsageMeteringApiResponseProcessor

Methods

getDailyCustomReports

getHourlyUsageAttribution

getIncidentManagement

Returns Promise<HourlyUsageAttributionResponse>

getIncidentManagement

getIngestedSpans

Returns Promise<UsageIncidentManagementResponse>

getIngestedSpans

getMonthlyCustomReports

Returns Promise<UsageIngestedSpansResponse>

getMonthlyCustomReports

getMonthlyUsageAttribution

Returns Promise<UsageCustomReportsResponse>

getMonthlyUsageAttribution

getSpecifiedDailyCustomReports

Returns Promise<MonthlyUsageAttributionResponse>

getSpecifiedDailyCustomReports

getSpecifiedMonthlyCustomReports

Returns Promise<UsageSpecifiedCustomReportsResponse>

getSpecifiedMonthlyCustomReports

getUsageAnalyzedLogs

Returns Promise<UsageSpecifiedCustomReportsResponse>

getUsageAnalyzedLogs

getUsageAttribution

Returns Promise<UsageAnalyzedLogsResponse>

getUsageAttribution

getUsageAuditLogs

Returns Promise<UsageAttributionResponse>

getUsageAuditLogs

getUsageBillableSummary

Returns Promise<UsageAuditLogsResponse>

getUsageBillableSummary

getUsageCWS

Returns Promise<UsageBillableSummaryResponse>

getUsageCWS

getUsageCloudSecurityPostureManagement

Returns Promise<UsageCWSResponse>

getUsageCloudSecurityPostureManagement

getUsageDBM

Returns Promise<UsageCloudSecurityPostureManagementResponse>

getUsageDBM

getUsageFargate

Returns Promise<UsageDBMResponse>

getUsageFargate

getUsageHosts

Returns Promise<UsageFargateResponse>

getUsageHosts

getUsageIndexedSpans

Returns Promise<UsageHostsResponse>

getUsageIndexedSpans

getUsageInternetOfThings

Returns Promise<UsageIndexedSpansResponse>

getUsageInternetOfThings

getUsageLambda

Returns Promise<UsageIoTResponse>

getUsageLambda

getUsageLogs

Returns Promise<UsageLambdaResponse>

getUsageLogs

getUsageLogsByIndex

Returns Promise<UsageLogsResponse>

getUsageLogsByIndex

getUsageLogsByRetention

Returns Promise<UsageLogsByIndexResponse>

getUsageLogsByRetention

getUsageNetworkFlows

Returns Promise<UsageLogsByRetentionResponse>

getUsageNetworkFlows

getUsageNetworkHosts

Returns Promise<UsageNetworkFlowsResponse>

getUsageNetworkHosts

getUsageProfiling

Returns Promise<UsageNetworkHostsResponse>

getUsageProfiling

getUsageRumSessions

Returns Promise<UsageProfilingResponse>

getUsageRumSessions

getUsageRumUnits

Returns Promise<UsageRumSessionsResponse>

getUsageRumUnits

getUsageSDS

Returns Promise<UsageRumUnitsResponse>

getUsageSDS

getUsageSNMP

Returns Promise<UsageSDSResponse>

getUsageSNMP

getUsageSummary

Returns Promise<UsageSNMPResponse>

getUsageSummary

getUsageSynthetics

Returns Promise<UsageSummaryResponse>

getUsageSynthetics

getUsageSyntheticsAPI

Returns Promise<UsageSyntheticsResponse>

getUsageSyntheticsAPI

getUsageSyntheticsBrowser

Returns Promise<UsageSyntheticsAPIResponse>

getUsageSyntheticsBrowser

getUsageTimeseries

Returns Promise<UsageSyntheticsBrowserResponse>

getUsageTimeseries

getUsageTopAvgMetrics

Returns Promise<UsageTimeseriesResponse>

getUsageTopAvgMetrics

Optional type

type?: "reports"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSpecifiedCustomReportsMeta.html b/classes/v1.UsageSpecifiedCustomReportsMeta.html index 6c9eb1744bd..fb420a99384 100644 --- a/classes/v1.UsageSpecifiedCustomReportsMeta.html +++ b/classes/v1.UsageSpecifiedCustomReportsMeta.html @@ -1,3 +1,3 @@ UsageSpecifiedCustomReportsMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSpecifiedCustomReportsMeta

The object containing document metadata.

-

Hierarchy

  • UsageSpecifiedCustomReportsMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: UsageSpecifiedCustomReportsPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UsageSpecifiedCustomReportsMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: UsageSpecifiedCustomReportsPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSpecifiedCustomReportsPage.html b/classes/v1.UsageSpecifiedCustomReportsPage.html index f8cca50a2fd..a266b7d0b8c 100644 --- a/classes/v1.UsageSpecifiedCustomReportsPage.html +++ b/classes/v1.UsageSpecifiedCustomReportsPage.html @@ -1,5 +1,5 @@ UsageSpecifiedCustomReportsPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSpecifiedCustomReportsPage

The object containing page total count for specified ID.

-

Hierarchy

  • UsageSpecifiedCustomReportsPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number
+

Hierarchy

  • UsageSpecifiedCustomReportsPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number

Total page count.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSpecifiedCustomReportsResponse.html b/classes/v1.UsageSpecifiedCustomReportsResponse.html index 89ea5995c3a..ab97f1981f9 100644 --- a/classes/v1.UsageSpecifiedCustomReportsResponse.html +++ b/classes/v1.UsageSpecifiedCustomReportsResponse.html @@ -1,3 +1,3 @@ UsageSpecifiedCustomReportsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSpecifiedCustomReportsResponse

Returns available specified custom reports.

-

Hierarchy

  • UsageSpecifiedCustomReportsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UsageSpecifiedCustomReportsData

Optional meta

meta?: UsageSpecifiedCustomReportsMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UsageSpecifiedCustomReportsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UsageSpecifiedCustomReportsData

Optional meta

meta?: UsageSpecifiedCustomReportsMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSummaryDate.html b/classes/v1.UsageSummaryDate.html index 924f4fa9c74..d0634c76472 100644 --- a/classes/v1.UsageSummaryDate.html +++ b/classes/v1.UsageSummaryDate.html @@ -1,117 +1,117 @@ UsageSummaryDate | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSummaryDate

Response with hourly report of all data billed by Datadog all organizations.

-

Hierarchy

  • UsageSummaryDate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostTop99p

agentHostTop99p?: number
+

Hierarchy

  • UsageSummaryDate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostTop99p

agentHostTop99p?: number

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

-

Optional apmAzureAppServiceHostTop99p

apmAzureAppServiceHostTop99p?: number
+

Optional apmAzureAppServiceHostTop99p

apmAzureAppServiceHostTop99p?: number

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

-

Optional apmHostTop99p

apmHostTop99p?: number
+

Optional apmHostTop99p

apmHostTop99p?: number

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

-

Optional auditLogsLinesIndexedSum

auditLogsLinesIndexedSum?: number
+

Optional auditLogsLinesIndexedSum

auditLogsLinesIndexedSum?: number

Shows the sum of audit logs lines indexed over all hours in the current date for all organizations.

-

Optional avgProfiledFargateTasks

avgProfiledFargateTasks?: number
+

Optional avgProfiledFargateTasks

avgProfiledFargateTasks?: number

The average profiled task count for Fargate Profiling.

-

Optional awsHostTop99p

awsHostTop99p?: number
+

Optional awsHostTop99p

awsHostTop99p?: number

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

-

Optional awsLambdaFuncCount

awsLambdaFuncCount?: number
+

Optional awsLambdaFuncCount

awsLambdaFuncCount?: number

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

-

Optional awsLambdaInvocationsSum

awsLambdaInvocationsSum?: number
+

Optional awsLambdaInvocationsSum

awsLambdaInvocationsSum?: number

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

-

Optional azureAppServiceTop99p

azureAppServiceTop99p?: number
+

Optional azureAppServiceTop99p

azureAppServiceTop99p?: number

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

-

Optional billableIngestedBytesSum

billableIngestedBytesSum?: number
+

Optional billableIngestedBytesSum

billableIngestedBytesSum?: number

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

-

Optional browserRumLiteSessionCountSum

browserRumLiteSessionCountSum?: number
+

Optional browserRumLiteSessionCountSum

browserRumLiteSessionCountSum?: number

Shows the sum of all browser lite sessions over all hours in the current date for all organizations.

-

Optional browserRumReplaySessionCountSum

browserRumReplaySessionCountSum?: number
+

Optional browserRumReplaySessionCountSum

browserRumReplaySessionCountSum?: number

Shows the sum of all browser replay sessions over all hours in the current date for all organizations.

-

Optional browserRumUnitsSum

browserRumUnitsSum?: number
+

Optional browserRumUnitsSum

browserRumUnitsSum?: number

Shows the sum of all browser RUM units over all hours in the current date for all organizations.

-

Optional containerAvg

containerAvg?: number
+

Optional containerAvg

containerAvg?: number

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

-

Optional containerHwm

containerHwm?: number
+

Optional containerHwm

containerHwm?: number

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

-

Optional cspmAasHostTop99p

cspmAasHostTop99p?: number
+

Optional cspmAasHostTop99p

cspmAasHostTop99p?: number

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

-

Optional cspmAzureHostTop99p

cspmAzureHostTop99p?: number
+

Optional cspmAzureHostTop99p

cspmAzureHostTop99p?: number

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

-

Optional cspmContainerAvg

cspmContainerAvg?: number
+

Optional cspmContainerAvg

cspmContainerAvg?: number

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

-

Optional cspmContainerHwm

cspmContainerHwm?: number
+

Optional cspmContainerHwm

cspmContainerHwm?: number

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

-

Optional cspmHostTop99p

cspmHostTop99p?: number
+

Optional cspmHostTop99p

cspmHostTop99p?: number

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

-

Optional customTsAvg

customTsAvg?: number
+

Optional customTsAvg

customTsAvg?: number

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

-

Optional cwsContainerCountAvg

cwsContainerCountAvg?: number
+

Optional cwsContainerCountAvg

cwsContainerCountAvg?: number

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

-

Optional cwsHostTop99p

cwsHostTop99p?: number
+

Optional cwsHostTop99p

cwsHostTop99p?: number

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

-

Optional date

date?: Date
+

Optional date

date?: Date

The date for the usage.

-

Optional dbmHostTop99p

dbmHostTop99p?: number
+

Optional dbmHostTop99p

dbmHostTop99p?: number

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

-

Optional dbmQueriesCountAvg

dbmQueriesCountAvg?: number
+

Optional dbmQueriesCountAvg

dbmQueriesCountAvg?: number

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

-

Optional fargateTasksCountAvg

fargateTasksCountAvg?: number
+

Optional fargateTasksCountAvg

fargateTasksCountAvg?: number

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

-

Optional fargateTasksCountHwm

fargateTasksCountHwm?: number
+

Optional fargateTasksCountHwm

fargateTasksCountHwm?: number

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

-

Optional gcpHostTop99p

gcpHostTop99p?: number
+

Optional gcpHostTop99p

gcpHostTop99p?: number

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

-

Optional herokuHostTop99p

herokuHostTop99p?: number
+

Optional herokuHostTop99p

herokuHostTop99p?: number

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

-

Optional incidentManagementMonthlyActiveUsersHwm

incidentManagementMonthlyActiveUsersHwm?: number
+

Optional incidentManagementMonthlyActiveUsersHwm

incidentManagementMonthlyActiveUsersHwm?: number

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

-

Optional indexedEventsCountSum

indexedEventsCountSum?: number
+

Optional indexedEventsCountSum

indexedEventsCountSum?: number

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

-

Optional infraHostTop99p

infraHostTop99p?: number
+

Optional infraHostTop99p

infraHostTop99p?: number

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

-

Optional ingestedEventsBytesSum

ingestedEventsBytesSum?: number
+

Optional ingestedEventsBytesSum

ingestedEventsBytesSum?: number

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

-

Optional iotDeviceSum

iotDeviceSum?: number
+

Optional iotDeviceSum

iotDeviceSum?: number

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

-

Optional iotDeviceTop99p

iotDeviceTop99p?: number
+

Optional iotDeviceTop99p

iotDeviceTop99p?: number

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

-

Optional mobileRumLiteSessionCountSum

mobileRumLiteSessionCountSum?: number
+

Optional mobileRumLiteSessionCountSum

mobileRumLiteSessionCountSum?: number

Shows the sum of all mobile lite sessions over all hours in the current date for all organizations.

-

Optional mobileRumSessionCountAndroidSum

mobileRumSessionCountAndroidSum?: number
+

Optional mobileRumSessionCountAndroidSum

mobileRumSessionCountAndroidSum?: number

Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for all organizations.

-

Optional mobileRumSessionCountIosSum

mobileRumSessionCountIosSum?: number
+

Optional mobileRumSessionCountIosSum

mobileRumSessionCountIosSum?: number

Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for all organizations.

-

Optional mobileRumSessionCountSum

mobileRumSessionCountSum?: number
+

Optional mobileRumSessionCountSum

mobileRumSessionCountSum?: number

Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations

-

Optional mobileRumUnitsSum

mobileRumUnitsSum?: number
+

Optional mobileRumUnitsSum

mobileRumUnitsSum?: number

Shows the sum of all mobile RUM units over all hours in the current date for all organizations.

-

Optional netflowIndexedEventsCountSum

netflowIndexedEventsCountSum?: number
+

Optional netflowIndexedEventsCountSum

netflowIndexedEventsCountSum?: number

Shows the sum of all Network flows indexed over all hours in the current date for all organizations.

-

Optional npmHostTop99p

npmHostTop99p?: number
+

Optional npmHostTop99p

npmHostTop99p?: number

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

-

Optional opentelemetryHostTop99p

opentelemetryHostTop99p?: number
+

Optional opentelemetryHostTop99p

opentelemetryHostTop99p?: number

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

-

Optional orgs

orgs?: UsageSummaryDateOrg[]
+

Optional orgs

orgs?: UsageSummaryDateOrg[]

Organizations associated with a user.

-

Optional profilingHostTop99p

profilingHostTop99p?: number
+

Optional profilingHostTop99p

profilingHostTop99p?: number

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

-

Optional rumBrowserAndMobileSessionCount

rumBrowserAndMobileSessionCount?: number
+

Optional rumBrowserAndMobileSessionCount

rumBrowserAndMobileSessionCount?: number

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations.

-

Optional rumSessionCountSum

rumSessionCountSum?: number
+

Optional rumSessionCountSum

rumSessionCountSum?: number

Shows the sum of all browser RUM Lite Sessions over all hours in the current date for all organizations

-

Optional rumTotalSessionCountSum

rumTotalSessionCountSum?: number
+

Optional rumTotalSessionCountSum

rumTotalSessionCountSum?: number

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

-

Optional rumUnitsSum

rumUnitsSum?: number
+

Optional rumUnitsSum

rumUnitsSum?: number

Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations.

-

Optional sdsLogsScannedBytesSum

sdsLogsScannedBytesSum?: number
+

Optional sdsLogsScannedBytesSum

sdsLogsScannedBytesSum?: number

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

-

Optional sdsTotalScannedBytesSum

sdsTotalScannedBytesSum?: number
+

Optional sdsTotalScannedBytesSum

sdsTotalScannedBytesSum?: number

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

-

Optional syntheticsBrowserCheckCallsCountSum

syntheticsBrowserCheckCallsCountSum?: number
+

Optional syntheticsBrowserCheckCallsCountSum

syntheticsBrowserCheckCallsCountSum?: number

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

-

Optional syntheticsCheckCallsCountSum

syntheticsCheckCallsCountSum?: number
+

Optional syntheticsCheckCallsCountSum

syntheticsCheckCallsCountSum?: number

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

-

Optional traceSearchIndexedEventsCountSum

traceSearchIndexedEventsCountSum?: number
+

Optional traceSearchIndexedEventsCountSum

traceSearchIndexedEventsCountSum?: number

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

-

Optional twolIngestedEventsBytesSum

twolIngestedEventsBytesSum?: number
+

Optional twolIngestedEventsBytesSum

twolIngestedEventsBytesSum?: number

Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations.

-

Optional vsphereHostTop99p

vsphereHostTop99p?: number
+

Optional vsphereHostTop99p

vsphereHostTop99p?: number

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

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSummaryDateOrg.html b/classes/v1.UsageSummaryDateOrg.html index 773316b954c..391be612455 100644 --- a/classes/v1.UsageSummaryDateOrg.html +++ b/classes/v1.UsageSummaryDateOrg.html @@ -1,119 +1,119 @@ UsageSummaryDateOrg | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSummaryDateOrg

Global hourly report of all data billed by Datadog for a given organization.

-

Hierarchy

  • UsageSummaryDateOrg

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostTop99p

agentHostTop99p?: number
+

Hierarchy

  • UsageSummaryDateOrg

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostTop99p

agentHostTop99p?: number

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

-

Optional apmAzureAppServiceHostTop99p

apmAzureAppServiceHostTop99p?: number
+

Optional apmAzureAppServiceHostTop99p

apmAzureAppServiceHostTop99p?: number

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

-

Optional apmHostTop99p

apmHostTop99p?: number
+

Optional apmHostTop99p

apmHostTop99p?: number

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

-

Optional auditLogsLinesIndexedSum

auditLogsLinesIndexedSum?: number
+

Optional auditLogsLinesIndexedSum

auditLogsLinesIndexedSum?: number

Shows the sum of all audit logs lines indexed over all hours in the current date for the given org.

-

Optional avgProfiledFargateTasks

avgProfiledFargateTasks?: number
+

Optional avgProfiledFargateTasks

avgProfiledFargateTasks?: number

The average profiled task count for Fargate Profiling.

-

Optional awsHostTop99p

awsHostTop99p?: number
+

Optional awsHostTop99p

awsHostTop99p?: number

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

-

Optional awsLambdaFuncCount

awsLambdaFuncCount?: number
+

Optional awsLambdaFuncCount

awsLambdaFuncCount?: number

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

-

Optional awsLambdaInvocationsSum

awsLambdaInvocationsSum?: number
+

Optional awsLambdaInvocationsSum

awsLambdaInvocationsSum?: number

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

-

Optional azureAppServiceTop99p

azureAppServiceTop99p?: number
+

Optional azureAppServiceTop99p

azureAppServiceTop99p?: number

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

-

Optional billableIngestedBytesSum

billableIngestedBytesSum?: number
+

Optional billableIngestedBytesSum

billableIngestedBytesSum?: number

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

-

Optional browserRumLiteSessionCountSum

browserRumLiteSessionCountSum?: number
+

Optional browserRumLiteSessionCountSum

browserRumLiteSessionCountSum?: number

Shows the sum of all browser lite sessions over all hours in the current date for the given org.

-

Optional browserRumReplaySessionCountSum

browserRumReplaySessionCountSum?: number
+

Optional browserRumReplaySessionCountSum

browserRumReplaySessionCountSum?: number

Shows the sum of all browser replay sessions over all hours in the current date for the given org.

-

Optional browserRumUnitsSum

browserRumUnitsSum?: number
+

Optional browserRumUnitsSum

browserRumUnitsSum?: number

Shows the sum of all browser RUM units over all hours in the current date for the given org.

-

Optional containerAvg

containerAvg?: number
+

Optional containerAvg

containerAvg?: number

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

-

Optional containerHwm

containerHwm?: number
+

Optional containerHwm

containerHwm?: number

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

-

Optional cspmAasHostTop99p

cspmAasHostTop99p?: number
+

Optional cspmAasHostTop99p

cspmAasHostTop99p?: number

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

-

Optional cspmAzureHostTop99p

cspmAzureHostTop99p?: number
+

Optional cspmAzureHostTop99p

cspmAzureHostTop99p?: number

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

-

Optional cspmContainerAvg

cspmContainerAvg?: number
+

Optional cspmContainerAvg

cspmContainerAvg?: number

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

-

Optional cspmContainerHwm

cspmContainerHwm?: number
+

Optional cspmContainerHwm

cspmContainerHwm?: number

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

-

Optional cspmHostTop99p

cspmHostTop99p?: number
+

Optional cspmHostTop99p

cspmHostTop99p?: number

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

-

Optional customTsAvg

customTsAvg?: number
+

Optional customTsAvg

customTsAvg?: number

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

-

Optional cwsContainerCountAvg

cwsContainerCountAvg?: number
+

Optional cwsContainerCountAvg

cwsContainerCountAvg?: number

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

-

Optional cwsHostTop99p

cwsHostTop99p?: number
+

Optional cwsHostTop99p

cwsHostTop99p?: number

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

-

Optional dbmHostTop99pSum

dbmHostTop99pSum?: number
+

Optional dbmHostTop99pSum

dbmHostTop99pSum?: number

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

-

Optional dbmQueriesAvgSum

dbmQueriesAvgSum?: number
+

Optional dbmQueriesAvgSum

dbmQueriesAvgSum?: number

Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for the given org.

-

Optional fargateTasksCountAvg

fargateTasksCountAvg?: number
+

Optional fargateTasksCountAvg

fargateTasksCountAvg?: number

The average task count for Fargate.

-

Optional fargateTasksCountHwm

fargateTasksCountHwm?: number
+

Optional fargateTasksCountHwm

fargateTasksCountHwm?: number

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

-

Optional gcpHostTop99p

gcpHostTop99p?: number
+

Optional gcpHostTop99p

gcpHostTop99p?: number

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

-

Optional herokuHostTop99p

herokuHostTop99p?: number
+

Optional herokuHostTop99p

herokuHostTop99p?: number

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

-

Optional id

id?: string
+

Optional id

id?: string

The organization id.

-

Optional incidentManagementMonthlyActiveUsersHwm

incidentManagementMonthlyActiveUsersHwm?: number
+

Optional incidentManagementMonthlyActiveUsersHwm

incidentManagementMonthlyActiveUsersHwm?: number

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

-

Optional indexedEventsCountSum

indexedEventsCountSum?: number
+

Optional indexedEventsCountSum

indexedEventsCountSum?: number

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

-

Optional infraHostTop99p

infraHostTop99p?: number
+

Optional infraHostTop99p

infraHostTop99p?: number

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

-

Optional ingestedEventsBytesSum

ingestedEventsBytesSum?: number
+

Optional ingestedEventsBytesSum

ingestedEventsBytesSum?: number

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

-

Optional iotDeviceAggSum

iotDeviceAggSum?: number
+

Optional iotDeviceAggSum

iotDeviceAggSum?: number

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

-

Optional iotDeviceTop99pSum

iotDeviceTop99pSum?: number
+

Optional iotDeviceTop99pSum

iotDeviceTop99pSum?: number

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

-

Optional mobileRumLiteSessionCountSum

mobileRumLiteSessionCountSum?: number
+

Optional mobileRumLiteSessionCountSum

mobileRumLiteSessionCountSum?: number

Shows the sum of all mobile lite sessions over all hours in the current date for the given org.

-

Optional mobileRumSessionCountAndroidSum

mobileRumSessionCountAndroidSum?: number
+

Optional mobileRumSessionCountAndroidSum

mobileRumSessionCountAndroidSum?: number

Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for the given org.

-

Optional mobileRumSessionCountIosSum

mobileRumSessionCountIosSum?: number
+

Optional mobileRumSessionCountIosSum

mobileRumSessionCountIosSum?: number

Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for the given org.

-

Optional mobileRumSessionCountSum

mobileRumSessionCountSum?: number
+

Optional mobileRumSessionCountSum

mobileRumSessionCountSum?: number

Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org.

-

Optional mobileRumUnitsSum

mobileRumUnitsSum?: number
+

Optional mobileRumUnitsSum

mobileRumUnitsSum?: number

Shows the sum of all mobile RUM units over all hours in the current date for the given org.

-

Optional name

name?: string
+

Optional name

name?: string

The organization name.

-

Optional netflowIndexedEventsCountSum

netflowIndexedEventsCountSum?: number
+

Optional netflowIndexedEventsCountSum

netflowIndexedEventsCountSum?: number

Shows the sum of all Network flows indexed over all hours in the current date for the given org.

-

Optional npmHostTop99p

npmHostTop99p?: number
+

Optional npmHostTop99p

npmHostTop99p?: number

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

-

Optional opentelemetryHostTop99p

opentelemetryHostTop99p?: number
+

Optional opentelemetryHostTop99p

opentelemetryHostTop99p?: number

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

-

Optional profilingHostTop99p

profilingHostTop99p?: number
+

Optional profilingHostTop99p

profilingHostTop99p?: number

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

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public id.

-

Optional rumBrowserAndMobileSessionCount

rumBrowserAndMobileSessionCount?: number
+

Optional rumBrowserAndMobileSessionCount

rumBrowserAndMobileSessionCount?: number

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current date for the given org.

-

Optional rumSessionCountSum

rumSessionCountSum?: number
+

Optional rumSessionCountSum

rumSessionCountSum?: number

Shows the sum of all browser RUM Lite Sessions over all hours in the current date for the given org.

-

Optional rumTotalSessionCountSum

rumTotalSessionCountSum?: number
+

Optional rumTotalSessionCountSum

rumTotalSessionCountSum?: number

Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org.

-

Optional rumUnitsSum

rumUnitsSum?: number
+

Optional rumUnitsSum

rumUnitsSum?: number

Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org.

-

Optional sdsLogsScannedBytesSum

sdsLogsScannedBytesSum?: number
+

Optional sdsLogsScannedBytesSum

sdsLogsScannedBytesSum?: number

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

-

Optional sdsTotalScannedBytesSum

sdsTotalScannedBytesSum?: number
+

Optional sdsTotalScannedBytesSum

sdsTotalScannedBytesSum?: number

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

-

Optional syntheticsBrowserCheckCallsCountSum

syntheticsBrowserCheckCallsCountSum?: number
+

Optional syntheticsBrowserCheckCallsCountSum

syntheticsBrowserCheckCallsCountSum?: number

Shows the sum of all Synthetic browser tests over all hours in the current date for the given org.

-

Optional syntheticsCheckCallsCountSum

syntheticsCheckCallsCountSum?: number
+

Optional syntheticsCheckCallsCountSum

syntheticsCheckCallsCountSum?: number

Shows the sum of all Synthetic API tests over all hours in the current date for the given org.

-

Optional traceSearchIndexedEventsCountSum

traceSearchIndexedEventsCountSum?: number
+

Optional traceSearchIndexedEventsCountSum

traceSearchIndexedEventsCountSum?: number

Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org.

-

Optional twolIngestedEventsBytesSum

twolIngestedEventsBytesSum?: number
+

Optional twolIngestedEventsBytesSum

twolIngestedEventsBytesSum?: number

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

-

Optional vsphereHostTop99p

vsphereHostTop99p?: number
+

Optional vsphereHostTop99p

vsphereHostTop99p?: number

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

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSummaryResponse.html b/classes/v1.UsageSummaryResponse.html index 792ca95bece..44e730533fa 100644 --- a/classes/v1.UsageSummaryResponse.html +++ b/classes/v1.UsageSummaryResponse.html @@ -1,133 +1,133 @@ UsageSummaryResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSummaryResponse

Response summarizing all usage aggregated across the months in the request for all organizations, and broken down by month and by organization.

-

Hierarchy

  • UsageSummaryResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostTop99pSum

agentHostTop99pSum?: number
+

Hierarchy

  • UsageSummaryResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional agentHostTop99pSum

agentHostTop99pSum?: number

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

-

Optional apmAzureAppServiceHostTop99pSum

apmAzureAppServiceHostTop99pSum?: number
+

Optional apmAzureAppServiceHostTop99pSum

apmAzureAppServiceHostTop99pSum?: number

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

-

Optional apmHostTop99pSum

apmHostTop99pSum?: number
+

Optional apmHostTop99pSum

apmHostTop99pSum?: number

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

-

Optional auditLogsLinesIndexedAggSum

auditLogsLinesIndexedAggSum?: number
+

Optional auditLogsLinesIndexedAggSum

auditLogsLinesIndexedAggSum?: number

Shows the sum of all audit logs lines indexed over all hours in the current months for all organizations.

-

Optional avgProfiledFargateTasksSum

avgProfiledFargateTasksSum?: number
+

Optional avgProfiledFargateTasksSum

avgProfiledFargateTasksSum?: number

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

-

Optional awsHostTop99pSum

awsHostTop99pSum?: number
+

Optional awsHostTop99pSum

awsHostTop99pSum?: number

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

-

Optional awsLambdaFuncCount

awsLambdaFuncCount?: number
+

Optional awsLambdaFuncCount

awsLambdaFuncCount?: number

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

-

Optional awsLambdaInvocationsSum

awsLambdaInvocationsSum?: number
+

Optional awsLambdaInvocationsSum

awsLambdaInvocationsSum?: number

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

-

Optional azureAppServiceTop99pSum

azureAppServiceTop99pSum?: number
+

Optional azureAppServiceTop99pSum

azureAppServiceTop99pSum?: number

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

-

Optional azureHostTop99pSum

azureHostTop99pSum?: number
+

Optional azureHostTop99pSum

azureHostTop99pSum?: number

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

-

Optional billableIngestedBytesAggSum

billableIngestedBytesAggSum?: number
+

Optional billableIngestedBytesAggSum

billableIngestedBytesAggSum?: number

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

-

Optional browserRumLiteSessionCountAggSum

browserRumLiteSessionCountAggSum?: number
+

Optional browserRumLiteSessionCountAggSum

browserRumLiteSessionCountAggSum?: number

Shows the sum of all browser lite sessions over all hours in the current months for all organizations.

-

Optional browserRumReplaySessionCountAggSum

browserRumReplaySessionCountAggSum?: number
+

Optional browserRumReplaySessionCountAggSum

browserRumReplaySessionCountAggSum?: number

Shows the sum of all browser replay sessions over all hours in the current months for all organizations.

-

Optional browserRumUnitsAggSum

browserRumUnitsAggSum?: number
+

Optional browserRumUnitsAggSum

browserRumUnitsAggSum?: number

Shows the sum of all browser RUM units over all hours in the current months for all organizations.

-

Optional containerAvgSum

containerAvgSum?: number
+

Optional containerAvgSum

containerAvgSum?: number

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

-

Optional containerHwmSum

containerHwmSum?: number
+

Optional containerHwmSum

containerHwmSum?: number

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

-

Optional cspmAasHostTop99pSum

cspmAasHostTop99pSum?: number
+

Optional cspmAasHostTop99pSum

cspmAasHostTop99pSum?: number

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

-

Optional cspmAzureHostTop99pSum

cspmAzureHostTop99pSum?: number
+

Optional cspmAzureHostTop99pSum

cspmAzureHostTop99pSum?: number

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

-

Optional cspmContainerAvgSum

cspmContainerAvgSum?: number
+

Optional cspmContainerAvgSum

cspmContainerAvgSum?: number

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

-

Optional cspmContainerHwmSum

cspmContainerHwmSum?: number
+

Optional cspmContainerHwmSum

cspmContainerHwmSum?: number

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

-

Optional cspmHostTop99pSum

cspmHostTop99pSum?: number
+

Optional cspmHostTop99pSum

cspmHostTop99pSum?: number

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

-

Optional customTsSum

customTsSum?: number
+

Optional customTsSum

customTsSum?: number

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

-

Optional cwsContainersAvgSum

cwsContainersAvgSum?: number
+

Optional cwsContainersAvgSum

cwsContainersAvgSum?: number

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

-

Optional cwsHostTop99pSum

cwsHostTop99pSum?: number
+

Optional cwsHostTop99pSum

cwsHostTop99pSum?: number

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

-

Optional dbmHostTop99pSum

dbmHostTop99pSum?: number
+

Optional dbmHostTop99pSum

dbmHostTop99pSum?: number

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

-

Optional dbmQueriesAvgSum

dbmQueriesAvgSum?: number
+

Optional dbmQueriesAvgSum

dbmQueriesAvgSum?: number

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

-

Optional endDate

endDate?: Date
+

Optional endDate

endDate?: Date

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

-

Optional fargateTasksCountAvgSum

fargateTasksCountAvgSum?: number
+

Optional fargateTasksCountAvgSum

fargateTasksCountAvgSum?: number

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

-

Optional fargateTasksCountHwmSum

fargateTasksCountHwmSum?: number
+

Optional fargateTasksCountHwmSum

fargateTasksCountHwmSum?: number

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

-

Optional gcpHostTop99pSum

gcpHostTop99pSum?: number
+

Optional gcpHostTop99pSum

gcpHostTop99pSum?: number

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

-

Optional herokuHostTop99pSum

herokuHostTop99pSum?: number
+

Optional herokuHostTop99pSum

herokuHostTop99pSum?: number

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

-

Optional incidentManagementMonthlyActiveUsersHwmSum

incidentManagementMonthlyActiveUsersHwmSum?: number
+

Optional incidentManagementMonthlyActiveUsersHwmSum

incidentManagementMonthlyActiveUsersHwmSum?: number

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

-

Optional indexedEventsCountAggSum

indexedEventsCountAggSum?: number
+

Optional indexedEventsCountAggSum

indexedEventsCountAggSum?: number

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

-

Optional infraHostTop99pSum

infraHostTop99pSum?: number
+

Optional infraHostTop99pSum

infraHostTop99pSum?: number

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

-

Optional ingestedEventsBytesAggSum

ingestedEventsBytesAggSum?: number
+

Optional ingestedEventsBytesAggSum

ingestedEventsBytesAggSum?: number

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

-

Optional iotDeviceAggSum

iotDeviceAggSum?: number
+

Optional iotDeviceAggSum

iotDeviceAggSum?: number

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

-

Optional iotDeviceTop99pSum

iotDeviceTop99pSum?: number
+

Optional iotDeviceTop99pSum

iotDeviceTop99pSum?: number

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

-

Optional lastUpdated

lastUpdated?: Date
+

Optional lastUpdated

lastUpdated?: Date

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

-

Optional liveIndexedEventsAggSum

liveIndexedEventsAggSum?: number
+

Optional liveIndexedEventsAggSum

liveIndexedEventsAggSum?: number

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

-

Optional liveIngestedBytesAggSum

liveIngestedBytesAggSum?: number
+

Optional liveIngestedBytesAggSum

liveIngestedBytesAggSum?: number

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

-

Optional logsByRetention

logsByRetention?: LogsByRetention

Optional mobileRumLiteSessionCountAggSum

mobileRumLiteSessionCountAggSum?: number
+

Optional logsByRetention

logsByRetention?: LogsByRetention

Optional mobileRumLiteSessionCountAggSum

mobileRumLiteSessionCountAggSum?: number

Shows the sum of all mobile lite sessions over all hours in the current months for all organizations.

-

Optional mobileRumSessionCountAggSum

mobileRumSessionCountAggSum?: number
+

Optional mobileRumSessionCountAggSum

mobileRumSessionCountAggSum?: number

Shows the sum of all mobile RUM Sessions over all hours in the current months for all organizations.

-

Optional mobileRumSessionCountAndroidAggSum

mobileRumSessionCountAndroidAggSum?: number
+

Optional mobileRumSessionCountAndroidAggSum

mobileRumSessionCountAndroidAggSum?: number

Shows the sum of all mobile RUM Sessions on Android over all hours in the current months for all organizations.

-

Optional mobileRumSessionCountIosAggSum

mobileRumSessionCountIosAggSum?: number
+

Optional mobileRumSessionCountIosAggSum

mobileRumSessionCountIosAggSum?: number

Shows the sum of all mobile RUM Sessions on iOS over all hours in the current months for all organizations.

-

Optional mobileRumUnitsAggSum

mobileRumUnitsAggSum?: number
+

Optional mobileRumUnitsAggSum

mobileRumUnitsAggSum?: number

Shows the sum of all mobile RUM units over all hours in the current months for all organizations.

-

Optional netflowIndexedEventsCountAggSum

netflowIndexedEventsCountAggSum?: number
+

Optional netflowIndexedEventsCountAggSum

netflowIndexedEventsCountAggSum?: number

Shows the sum of all Network flows indexed over all hours in the current months for all organizations.

-

Optional npmHostTop99pSum

npmHostTop99pSum?: number
+

Optional npmHostTop99pSum

npmHostTop99pSum?: number

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

-

Optional opentelemetryHostTop99pSum

opentelemetryHostTop99pSum?: number
+

Optional opentelemetryHostTop99pSum

opentelemetryHostTop99pSum?: number

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

-

Optional profilingContainerAgentCountAvg

profilingContainerAgentCountAvg?: number
+

Optional profilingContainerAgentCountAvg

profilingContainerAgentCountAvg?: number

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

-

Optional profilingHostCountTop99pSum

profilingHostCountTop99pSum?: number
+

Optional profilingHostCountTop99pSum

profilingHostCountTop99pSum?: number

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

-

Optional rehydratedIndexedEventsAggSum

rehydratedIndexedEventsAggSum?: number
+

Optional rehydratedIndexedEventsAggSum

rehydratedIndexedEventsAggSum?: number

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

-

Optional rehydratedIngestedBytesAggSum

rehydratedIngestedBytesAggSum?: number
+

Optional rehydratedIngestedBytesAggSum

rehydratedIngestedBytesAggSum?: number

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

-

Optional rumBrowserAndMobileSessionCount

rumBrowserAndMobileSessionCount?: number
+

Optional rumBrowserAndMobileSessionCount

rumBrowserAndMobileSessionCount?: number

Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations.

-

Optional rumSessionCountAggSum

rumSessionCountAggSum?: number
+

Optional rumSessionCountAggSum

rumSessionCountAggSum?: number

Shows the sum of all browser RUM Lite Sessions over all hours in the current months for all organizations.

-

Optional rumTotalSessionCountAggSum

rumTotalSessionCountAggSum?: number
+

Optional rumTotalSessionCountAggSum

rumTotalSessionCountAggSum?: number

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

-

Optional rumUnitsAggSum

rumUnitsAggSum?: number
+

Optional rumUnitsAggSum

rumUnitsAggSum?: number

Shows the sum of all browser and mobile RUM units over all hours in the current months for all organizations.

-

Optional sdsLogsScannedBytesSum

sdsLogsScannedBytesSum?: number
+

Optional sdsLogsScannedBytesSum

sdsLogsScannedBytesSum?: number

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

-

Optional sdsTotalScannedBytesSum

sdsTotalScannedBytesSum?: number
+

Optional sdsTotalScannedBytesSum

sdsTotalScannedBytesSum?: number

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

-

Optional startDate

startDate?: Date
+

Optional startDate

startDate?: Date

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

-

Optional syntheticsBrowserCheckCallsCountAggSum

syntheticsBrowserCheckCallsCountAggSum?: number
+

Optional syntheticsBrowserCheckCallsCountAggSum

syntheticsBrowserCheckCallsCountAggSum?: number

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

-

Optional syntheticsCheckCallsCountAggSum

syntheticsCheckCallsCountAggSum?: number
+

Optional syntheticsCheckCallsCountAggSum

syntheticsCheckCallsCountAggSum?: number

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

-

Optional traceSearchIndexedEventsCountAggSum

traceSearchIndexedEventsCountAggSum?: number
+

Optional traceSearchIndexedEventsCountAggSum

traceSearchIndexedEventsCountAggSum?: number

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

-

Optional twolIngestedEventsBytesAggSum

twolIngestedEventsBytesAggSum?: number
+

Optional twolIngestedEventsBytesAggSum

twolIngestedEventsBytesAggSum?: number

Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations.

-

Optional usage

usage?: UsageSummaryDate[]
+

Optional usage

usage?: UsageSummaryDate[]

An array of objects regarding hourly usage.

-

Optional vsphereHostTop99pSum

vsphereHostTop99pSum?: number
+

Optional vsphereHostTop99pSum

vsphereHostTop99pSum?: number

Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSyntheticsAPIHour.html b/classes/v1.UsageSyntheticsAPIHour.html index 4e1594680d1..500746af2e1 100644 --- a/classes/v1.UsageSyntheticsAPIHour.html +++ b/classes/v1.UsageSyntheticsAPIHour.html @@ -1,11 +1,11 @@ UsageSyntheticsAPIHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSyntheticsAPIHour

Number of Synthetics API tests run for each hour for a given organization.

-

Hierarchy

  • UsageSyntheticsAPIHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkCallsCount

checkCallsCount?: number
+

Hierarchy

  • UsageSyntheticsAPIHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkCallsCount

checkCallsCount?: number

Contains the number of Synthetics API tests run.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSyntheticsAPIResponse.html b/classes/v1.UsageSyntheticsAPIResponse.html index 45c99729e21..386f18778f5 100644 --- a/classes/v1.UsageSyntheticsAPIResponse.html +++ b/classes/v1.UsageSyntheticsAPIResponse.html @@ -1,5 +1,5 @@ UsageSyntheticsAPIResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSyntheticsAPIResponse

Response containing the number of Synthetics API tests run for each hour for a given organization.

-

Hierarchy

  • UsageSyntheticsAPIResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageSyntheticsAPIHour[]
+

Hierarchy

  • UsageSyntheticsAPIResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageSyntheticsAPIHour[]

Get hourly usage for Synthetics API tests.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSyntheticsBrowserHour.html b/classes/v1.UsageSyntheticsBrowserHour.html index 55604efa174..b2a34e05acd 100644 --- a/classes/v1.UsageSyntheticsBrowserHour.html +++ b/classes/v1.UsageSyntheticsBrowserHour.html @@ -1,11 +1,11 @@ UsageSyntheticsBrowserHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSyntheticsBrowserHour

Number of Synthetics Browser tests run for each hour for a given organization.

-

Hierarchy

  • UsageSyntheticsBrowserHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional browserCheckCallsCount

browserCheckCallsCount?: number
+

Hierarchy

  • UsageSyntheticsBrowserHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional browserCheckCallsCount

browserCheckCallsCount?: number

Contains the number of Synthetics Browser tests run.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSyntheticsBrowserResponse.html b/classes/v1.UsageSyntheticsBrowserResponse.html index 2f16d3c26da..380e8b77522 100644 --- a/classes/v1.UsageSyntheticsBrowserResponse.html +++ b/classes/v1.UsageSyntheticsBrowserResponse.html @@ -1,5 +1,5 @@ UsageSyntheticsBrowserResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSyntheticsBrowserResponse

Response containing the number of Synthetics Browser tests run for each hour for a given organization.

-

Hierarchy

  • UsageSyntheticsBrowserResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageSyntheticsBrowserHour[]
+

Hierarchy

  • UsageSyntheticsBrowserResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageSyntheticsBrowserHour[]

Get hourly usage for Synthetics Browser tests.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSyntheticsHour.html b/classes/v1.UsageSyntheticsHour.html index e818a2c2e97..f4560b36e3b 100644 --- a/classes/v1.UsageSyntheticsHour.html +++ b/classes/v1.UsageSyntheticsHour.html @@ -1,11 +1,11 @@ UsageSyntheticsHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSyntheticsHour

The number of synthetics tests run for each hour for a given organization.

-

Hierarchy

  • UsageSyntheticsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkCallsCount

checkCallsCount?: number
+

Hierarchy

  • UsageSyntheticsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional checkCallsCount

checkCallsCount?: number

Contains the number of Synthetics API tests run.

-

Optional hour

hour?: Date
+

Optional hour

hour?: Date

The hour for the usage.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageSyntheticsResponse.html b/classes/v1.UsageSyntheticsResponse.html index db34ff4a339..f3fb0d56ec3 100644 --- a/classes/v1.UsageSyntheticsResponse.html +++ b/classes/v1.UsageSyntheticsResponse.html @@ -1,5 +1,5 @@ UsageSyntheticsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageSyntheticsResponse

Response containing the number of Synthetics API tests run for each hour for a given organization.

-

Hierarchy

  • UsageSyntheticsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageSyntheticsHour[]
+

Hierarchy

  • UsageSyntheticsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageSyntheticsHour[]

Array with the number of hourly Synthetics test run for a given organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageTimeseriesHour.html b/classes/v1.UsageTimeseriesHour.html index 1f77679782a..58f6578d530 100644 --- a/classes/v1.UsageTimeseriesHour.html +++ b/classes/v1.UsageTimeseriesHour.html @@ -1,15 +1,15 @@ UsageTimeseriesHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageTimeseriesHour

The hourly usage of timeseries.

-

Hierarchy

  • UsageTimeseriesHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date
+

Hierarchy

  • UsageTimeseriesHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional hour

hour?: Date

The hour for the usage.

-

Optional numCustomInputTimeseries

numCustomInputTimeseries?: number
+

Optional numCustomInputTimeseries

numCustomInputTimeseries?: number

Contains the number of custom metrics that are inputs for aggregations (metric configured is custom).

-

Optional numCustomOutputTimeseries

numCustomOutputTimeseries?: number
+

Optional numCustomOutputTimeseries

numCustomOutputTimeseries?: number

Contains the number of custom metrics that are outputs for aggregations (metric configured is custom).

-

Optional numCustomTimeseries

numCustomTimeseries?: number
+

Optional numCustomTimeseries

numCustomTimeseries?: number

Contains sum of non-aggregation custom metrics and custom metrics that are outputs for aggregations.

-

Optional orgName

orgName?: string
+

Optional orgName

orgName?: string

The organization name.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

The organization public ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageTimeseriesResponse.html b/classes/v1.UsageTimeseriesResponse.html index 11db6934b11..07367053fc0 100644 --- a/classes/v1.UsageTimeseriesResponse.html +++ b/classes/v1.UsageTimeseriesResponse.html @@ -1,5 +1,5 @@ UsageTimeseriesResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageTimeseriesResponse

Response containing hourly usage of timeseries.

-

Hierarchy

  • UsageTimeseriesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageTimeseriesHour[]
+

Hierarchy

  • UsageTimeseriesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional usage

usage?: UsageTimeseriesHour[]

An array of objects regarding hourly usage of timeseries.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageTopAvgMetricsHour.html b/classes/v1.UsageTopAvgMetricsHour.html index 578d1e95052..4f5715fb6e3 100644 --- a/classes/v1.UsageTopAvgMetricsHour.html +++ b/classes/v1.UsageTopAvgMetricsHour.html @@ -1,9 +1,9 @@ UsageTopAvgMetricsHour | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageTopAvgMetricsHour

Number of hourly recorded custom metrics for a given organization.

-

Hierarchy

  • UsageTopAvgMetricsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional avgMetricHour

avgMetricHour?: number
+

Hierarchy

  • UsageTopAvgMetricsHour

Index

Constructors

Properties

Constructors

constructor

Properties

Optional avgMetricHour

avgMetricHour?: number

Average number of timeseries per hour in which the metric occurs.

-

Optional maxMetricHour

maxMetricHour?: number
+

Optional maxMetricHour

maxMetricHour?: number

Maximum number of timeseries per hour in which the metric occurs.

-

Optional metricCategory

metricCategory?: UsageMetricCategory

Optional metricName

metricName?: string
+

Optional metricCategory

metricCategory?: UsageMetricCategory

Optional metricName

metricName?: string

Contains the custom metric name.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageTopAvgMetricsMetadata.html b/classes/v1.UsageTopAvgMetricsMetadata.html index b60fac27b00..c308157953d 100644 --- a/classes/v1.UsageTopAvgMetricsMetadata.html +++ b/classes/v1.UsageTopAvgMetricsMetadata.html @@ -1,7 +1,7 @@ UsageTopAvgMetricsMetadata | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageTopAvgMetricsMetadata

The object containing document metadata.

-

Hierarchy

  • UsageTopAvgMetricsMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional day

day?: Date
+

Hierarchy

  • UsageTopAvgMetricsMetadata

Index

Constructors

Properties

Constructors

constructor

Properties

Optional day

day?: Date

The day value from the user request that contains the returned usage data. (If day was used the request)

-

Optional month

month?: Date
+

Optional month

month?: Date

The month value from the user request that contains the returned usage data. (If month was used the request)

-

Optional pagination

pagination?: UsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional pagination

pagination?: UsageAttributionPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsageTopAvgMetricsResponse.html b/classes/v1.UsageTopAvgMetricsResponse.html index 0fc12d7f7ee..8dac408447d 100644 --- a/classes/v1.UsageTopAvgMetricsResponse.html +++ b/classes/v1.UsageTopAvgMetricsResponse.html @@ -1,5 +1,5 @@ UsageTopAvgMetricsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageTopAvgMetricsResponse

Response containing the number of hourly recorded custom metrics for a given organization.

-

Hierarchy

  • UsageTopAvgMetricsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: UsageTopAvgMetricsMetadata

Optional usage

usage?: UsageTopAvgMetricsHour[]
+

Hierarchy

  • UsageTopAvgMetricsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional metadata

metadata?: UsageTopAvgMetricsMetadata

Optional usage

usage?: UsageTopAvgMetricsHour[]

Number of hourly recorded custom metrics for a given organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.User.html b/classes/v1.User.html index bcb46ec2670..03df7da8239 100644 --- a/classes/v1.User.html +++ b/classes/v1.User.html @@ -1,15 +1,15 @@ User | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Create, edit, and disable users.

-

Hierarchy

  • User

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accessRole

accessRole?: AccessRole

Optional disabled

disabled?: boolean
+

Hierarchy

  • User

Index

Constructors

Properties

Constructors

constructor

Properties

Optional accessRole

accessRole?: AccessRole

Optional disabled

disabled?: boolean

The new disabled status of the user.

-

Optional email

email?: string
+

Optional email

email?: string

The new email of the user.

-

Optional handle

handle?: string
+

Optional handle

handle?: string

The user handle, must be a valid email.

-

Optional icon

icon?: string
+

Optional icon

icon?: string

Gravatar icon associated to the user.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the user.

-

Optional verified

verified?: boolean
+

Optional verified

verified?: boolean

Whether or not the user logged in Datadog at least once.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UserDisableResponse.html b/classes/v1.UserDisableResponse.html index 51872291d1e..32cd2fe69e5 100644 --- a/classes/v1.UserDisableResponse.html +++ b/classes/v1.UserDisableResponse.html @@ -1,5 +1,5 @@ UserDisableResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserDisableResponse

Array of user disabled for a given organization.

-

Hierarchy

  • UserDisableResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional message

message?: string
+

Hierarchy

  • UserDisableResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional message

message?: string

Information pertaining to a user disabled for a given organization.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UserListResponse.html b/classes/v1.UserListResponse.html index 5daa1bdc3cd..7a6ad5d6c64 100644 --- a/classes/v1.UserListResponse.html +++ b/classes/v1.UserListResponse.html @@ -1,5 +1,5 @@ UserListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserListResponse

Array of Datadog users for a given organization.

-

Hierarchy

  • UserListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional users

users?: v1.User[]
+

Hierarchy

  • UserListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional users

users?: v1.User[]

Array of users.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UserResponse.html b/classes/v1.UserResponse.html index 1af365a7d43..cc530bc10c0 100644 --- a/classes/v1.UserResponse.html +++ b/classes/v1.UserResponse.html @@ -1,3 +1,3 @@ UserResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserResponse

A Datadog User.

-

Hierarchy

  • UserResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional user

user?: v1.User

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional user

user?: v1.User

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.UsersApi.html b/classes/v1.UsersApi.html index fff1437af58..58383e3ff92 100644 --- a/classes/v1.UsersApi.html +++ b/classes/v1.UsersApi.html @@ -1,18 +1,18 @@ -UsersApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsersApi

Hierarchy

  • UsersApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new UsersApi(configuration: v1.Configuration, requestFactory?: UsersApiRequestFactory, responseProcessor?: UsersApiResponseProcessor): v1.UsersApi

Properties

Private configuration

configuration: v1.Configuration

Private requestFactory

requestFactory: UsersApiRequestFactory

Private responseProcessor

responseProcessor: UsersApiResponseProcessor

Methods

createUser

disableUser

getUser

Returns Promise<UserDisableResponse>

getUser

listUsers

Returns Promise<v1.UserResponse>

listUsers

updateUser

updateUser

deleteWebhooksIntegration

deleteWebhooksIntegrationCustomVariable

Returns Promise<void>

deleteWebhooksIntegrationCustomVariable

getWebhooksIntegration

Returns Promise<void>

getWebhooksIntegration

getWebhooksIntegrationCustomVariable

Returns Promise<WebhooksIntegration>

getWebhooksIntegrationCustomVariable

updateWebhooksIntegration

Returns Promise<WebhooksIntegrationCustomVariableResponse>

updateWebhooksIntegration

updateWebhooksIntegrationCustomVariable

Returns Promise<WebhooksIntegration>

updateWebhooksIntegrationCustomVariable

Optional layout

layout?: WidgetLayout

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetAxis.html b/classes/v1.WidgetAxis.html index d9ad39c5ed9..cf3e34b1922 100644 --- a/classes/v1.WidgetAxis.html +++ b/classes/v1.WidgetAxis.html @@ -1,13 +1,13 @@ WidgetAxis | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetAxis

Axis controls for the widget.

-

Hierarchy

  • WidgetAxis

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeZero

includeZero?: boolean
+

Hierarchy

  • WidgetAxis

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeZero

includeZero?: boolean

True includes zero.

-

Optional label

label?: string
+

Optional label

label?: string

The label of the axis to display on the graph.

-

Optional max

max?: string
+

Optional max

max?: string

Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.

-

Optional min

min?: string
+

Optional min

min?: string

Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.

-

Optional scale

scale?: string
+

Optional scale

scale?: string

Specifies the scale type. Possible values are linear, log, sqrt, pow## (for example pow2, pow0.5 etc.).

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetConditionalFormat.html b/classes/v1.WidgetConditionalFormat.html index 63df7e4299d..1a6c136a6f1 100644 --- a/classes/v1.WidgetConditionalFormat.html +++ b/classes/v1.WidgetConditionalFormat.html @@ -1,17 +1,17 @@ WidgetConditionalFormat | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetConditionalFormat

Define a conditional format for the widget.

-

Hierarchy

  • WidgetConditionalFormat

Index

Constructors

Properties

Constructors

constructor

Properties

comparator

comparator: WidgetComparator

Optional customBgColor

customBgColor?: string
+

Hierarchy

  • WidgetConditionalFormat

Index

Constructors

Properties

Constructors

constructor

Properties

comparator

comparator: WidgetComparator

Optional customBgColor

customBgColor?: string

Color palette to apply to the background, same values available as palette.

-

Optional customFgColor

customFgColor?: string
+

Optional customFgColor

customFgColor?: string

Color palette to apply to the foreground, same values available as palette.

-

Optional hideValue

hideValue?: boolean
+

Optional hideValue

hideValue?: boolean

True hides values.

-

Optional imageUrl

imageUrl?: string
+

Optional imageUrl

imageUrl?: string

Displays an image as the background.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

Metric from the request to correlate this conditional format with.

-

palette

palette: WidgetPalette

Optional timeframe

timeframe?: string
+

palette

palette: WidgetPalette

Optional timeframe

timeframe?: string

Defines the displayed timeframe.

-

value

value: number
+

value

value: number

Value for the comparator.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetCustomLink.html b/classes/v1.WidgetCustomLink.html index 070a0817aa6..1866cfff3af 100644 --- a/classes/v1.WidgetCustomLink.html +++ b/classes/v1.WidgetCustomLink.html @@ -1,11 +1,11 @@ WidgetCustomLink | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetCustomLink

Custom links help you connect a data value to a URL, like a Datadog page or your AWS console.

-

Hierarchy

  • WidgetCustomLink

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isHidden

isHidden?: boolean
+

Hierarchy

  • WidgetCustomLink

Index

Constructors

Properties

Constructors

constructor

Properties

Optional isHidden

isHidden?: boolean

The flag for toggling context menu link visibility.

-

Optional label

label?: string
+

Optional label

label?: string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

-

Optional link

link?: string
+

Optional link

link?: string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

-

Optional overrideLabel

overrideLabel?: string
+

Optional overrideLabel

overrideLabel?: string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetEvent.html b/classes/v1.WidgetEvent.html index 2f92eb6b00a..727d44c1da5 100644 --- a/classes/v1.WidgetEvent.html +++ b/classes/v1.WidgetEvent.html @@ -1,7 +1,7 @@ WidgetEvent | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetEvent

Event overlay control options. See the dedicated Events JSON schema documentation to learn how to build the <EVENTS_SCHEMA>.

-

Hierarchy

  • WidgetEvent

Index

Constructors

Properties

Constructors

constructor

Properties

q

q: string
+

Hierarchy

  • WidgetEvent

Index

Constructors

Properties

Constructors

constructor

Properties

q

q: string

Query definition.

-

Optional tagsExecution

tagsExecution?: string
+

Optional tagsExecution

tagsExecution?: string

The execution method for multi-value filters.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetFieldSort.html b/classes/v1.WidgetFieldSort.html index 74a3ea8d958..5847e2776df 100644 --- a/classes/v1.WidgetFieldSort.html +++ b/classes/v1.WidgetFieldSort.html @@ -1,5 +1,5 @@ WidgetFieldSort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetFieldSort

Which column and order to sort by

-

Hierarchy

  • WidgetFieldSort

Index

Constructors

Properties

Constructors

constructor

Properties

column

column: string
+

Hierarchy

  • WidgetFieldSort

Index

Constructors

Properties

Constructors

constructor

Properties

column

column: string

Facet path for the column

-

order

order: WidgetSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

order

order: WidgetSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetFormula.html b/classes/v1.WidgetFormula.html index 542522797a2..803c3011e06 100644 --- a/classes/v1.WidgetFormula.html +++ b/classes/v1.WidgetFormula.html @@ -1,9 +1,9 @@ WidgetFormula | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetFormula

Formula to be used in a widget query.

-

Hierarchy

  • WidgetFormula

Index

Constructors

Properties

Constructors

constructor

Properties

Optional alias

alias?: string
+

Hierarchy

  • WidgetFormula

Index

Constructors

Properties

Constructors

constructor

Properties

Optional alias

alias?: string

Expression alias.

-

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]
+

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode

Optional conditionalFormats

conditionalFormats?: WidgetConditionalFormat[]

List of conditional formats.

-

formula

formula: string
+

formula

formula: string

String expression built from queries, formulas, and functions.

-

Optional limit

limit?: WidgetFormulaLimit

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional limit

limit?: WidgetFormulaLimit

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetFormulaLimit.html b/classes/v1.WidgetFormulaLimit.html index f781af29ccc..75a0adc8f12 100644 --- a/classes/v1.WidgetFormulaLimit.html +++ b/classes/v1.WidgetFormulaLimit.html @@ -1,5 +1,5 @@ WidgetFormulaLimit | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetFormulaLimit

Options for limiting results returned.

-

Hierarchy

  • WidgetFormulaLimit

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number
+

Hierarchy

  • WidgetFormulaLimit

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Number of results to return.

-

Optional order

order?: v1.QuerySortOrder

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional order

order?: v1.QuerySortOrder

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetLayout.html b/classes/v1.WidgetLayout.html index 3b7531f1eb5..ec565f8793d 100644 --- a/classes/v1.WidgetLayout.html +++ b/classes/v1.WidgetLayout.html @@ -1,13 +1,13 @@ WidgetLayout | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetLayout

The layout for a widget on a free or new dashboard layout dashboard.

-

Hierarchy

  • WidgetLayout

Index

Constructors

Properties

Constructors

constructor

Properties

height

height: number
+

Hierarchy

  • WidgetLayout

Index

Constructors

Properties

Constructors

constructor

Properties

height

height: number

The height of the widget. Should be a non-negative integer.

-

Optional isColumnBreak

isColumnBreak?: boolean
+

Optional isColumnBreak

isColumnBreak?: boolean

Whether the widget should be the first one on the second column in high density or not. Note: Only for the new dashboard layout and only one widget in the dashboard should have this property set to true.

-

width

width: number
+

width

width: number

The width of the widget. Should be a non-negative integer.

-

x

x: number
+

x

x: number

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

-

y

y: number
+

y

y: number

The position of the widget on the y (vertical) axis. Should be a non-negative integer.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetMarker.html b/classes/v1.WidgetMarker.html index 30c06fa4333..06a58510d35 100644 --- a/classes/v1.WidgetMarker.html +++ b/classes/v1.WidgetMarker.html @@ -1,11 +1,11 @@ WidgetMarker | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetMarker

Markers allow you to add visual conditional formatting for your graphs.

-

Hierarchy

  • WidgetMarker

Index

Constructors

Properties

Constructors

constructor

Properties

Optional displayType

displayType?: string
+

Hierarchy

  • WidgetMarker

Index

Constructors

Properties

Constructors

constructor

Properties

Optional displayType

displayType?: string

Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be x_axis_percentile.

-

Optional label

label?: string
+

Optional label

label?: string

Label to display over the marker.

-

Optional time

time?: string
+

Optional time

time?: string

Timestamp for the widget.

-

value

value: string
+

value

value: string

Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetRequestStyle.html b/classes/v1.WidgetRequestStyle.html index 51e32442b63..c0548f7ebe1 100644 --- a/classes/v1.WidgetRequestStyle.html +++ b/classes/v1.WidgetRequestStyle.html @@ -1,5 +1,5 @@ WidgetRequestStyle | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetRequestStyle

Define request widget style.

-

Hierarchy

  • WidgetRequestStyle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lineType

lineType?: WidgetLineType

Optional lineWidth

lineWidth?: WidgetLineWidth

Optional palette

palette?: string
+

Hierarchy

  • WidgetRequestStyle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional lineType

lineType?: WidgetLineType

Optional lineWidth

lineWidth?: WidgetLineWidth

Optional palette

palette?: string

Color palette to apply to the widget.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetStyle.html b/classes/v1.WidgetStyle.html index 5e01c39c006..f30ff359af0 100644 --- a/classes/v1.WidgetStyle.html +++ b/classes/v1.WidgetStyle.html @@ -1,5 +1,5 @@ WidgetStyle | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetStyle

Widget style definition.

-

Hierarchy

  • WidgetStyle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional palette

palette?: string
+

Hierarchy

  • WidgetStyle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional palette

palette?: string

Color palette to apply to the widget.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.WidgetTime.html b/classes/v1.WidgetTime.html index 0399b3c9e86..fd042b2903a 100644 --- a/classes/v1.WidgetTime.html +++ b/classes/v1.WidgetTime.html @@ -1,3 +1,3 @@ WidgetTime | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WidgetTime

Time setting for the widget.

-

Hierarchy

  • WidgetTime

Index

Constructors

Properties

Constructors

constructor

Properties

Optional liveSpan

liveSpan?: WidgetLiveSpan

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • WidgetTime

Index

Constructors

Properties

Constructors

constructor

Properties

Optional liveSpan

liveSpan?: WidgetLiveSpan

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIErrorResponse.html b/classes/v2.APIErrorResponse.html index aa5cdca7af6..27df17c4480 100644 --- a/classes/v2.APIErrorResponse.html +++ b/classes/v2.APIErrorResponse.html @@ -1,5 +1,5 @@ APIErrorResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIErrorResponse

API error response.

-

Hierarchy

  • APIErrorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

errors

errors: string[]
+

Hierarchy

  • APIErrorResponse

Index

Constructors

Properties

Constructors

constructor

Properties

errors

errors: string[]

A list of errors.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyCreateAttributes.html b/classes/v2.APIKeyCreateAttributes.html index 72901d6be33..c24610435ab 100644 --- a/classes/v2.APIKeyCreateAttributes.html +++ b/classes/v2.APIKeyCreateAttributes.html @@ -1,5 +1,5 @@ APIKeyCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyCreateAttributes

Attributes used to create an API Key.

-

Hierarchy

  • APIKeyCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • APIKeyCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the API key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyCreateData.html b/classes/v2.APIKeyCreateData.html index ce9f33191a5..f9b5d82bb5a 100644 --- a/classes/v2.APIKeyCreateData.html +++ b/classes/v2.APIKeyCreateData.html @@ -1,3 +1,3 @@ APIKeyCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyCreateData

Object used to create an API key.

-

Hierarchy

  • APIKeyCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: APIKeyCreateAttributes

type

type: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • APIKeyCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: APIKeyCreateAttributes

type

type: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyCreateRequest.html b/classes/v2.APIKeyCreateRequest.html index 5125f541681..04b4e831e6c 100644 --- a/classes/v2.APIKeyCreateRequest.html +++ b/classes/v2.APIKeyCreateRequest.html @@ -1,3 +1,3 @@ APIKeyCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyCreateRequest

Request used to create an API key.

-

Hierarchy

  • APIKeyCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: APIKeyCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • APIKeyCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: APIKeyCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyRelationships.html b/classes/v2.APIKeyRelationships.html index 1bfeece9fc0..75bf1f101fe 100644 --- a/classes/v2.APIKeyRelationships.html +++ b/classes/v2.APIKeyRelationships.html @@ -1,3 +1,3 @@ APIKeyRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyRelationships

Resources related to the API key.

-

Hierarchy

  • APIKeyRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdBy

createdBy?: RelationshipToUser

Optional modifiedBy

modifiedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • APIKeyRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdBy

createdBy?: RelationshipToUser

Optional modifiedBy

modifiedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyResponse.html b/classes/v2.APIKeyResponse.html index efc71677906..98af0fc1396 100644 --- a/classes/v2.APIKeyResponse.html +++ b/classes/v2.APIKeyResponse.html @@ -1,5 +1,5 @@ APIKeyResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyResponse

Response for retrieving an API key.

-

Hierarchy

  • APIKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: FullAPIKey

Optional included

included?: APIKeyResponseIncludedItem[]
+

Hierarchy

  • APIKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: FullAPIKey

Optional included

included?: APIKeyResponseIncludedItem[]

Array of objects related to the API key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyUpdateAttributes.html b/classes/v2.APIKeyUpdateAttributes.html index abf3736765b..cd40c1e3c4a 100644 --- a/classes/v2.APIKeyUpdateAttributes.html +++ b/classes/v2.APIKeyUpdateAttributes.html @@ -1,5 +1,5 @@ APIKeyUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyUpdateAttributes

Attributes used to update an API Key.

-

Hierarchy

  • APIKeyUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • APIKeyUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the API key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyUpdateData.html b/classes/v2.APIKeyUpdateData.html index 7b81affda9e..4432c8ba86f 100644 --- a/classes/v2.APIKeyUpdateData.html +++ b/classes/v2.APIKeyUpdateData.html @@ -1,5 +1,5 @@ APIKeyUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyUpdateData

Object used to update an API key.

-

Hierarchy

  • APIKeyUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: APIKeyUpdateAttributes

id

id: string
+

Hierarchy

  • APIKeyUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: APIKeyUpdateAttributes

id

id: string

ID of the API key.

-

type

type: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeyUpdateRequest.html b/classes/v2.APIKeyUpdateRequest.html index 901471b6d7f..d4c2953d4f8 100644 --- a/classes/v2.APIKeyUpdateRequest.html +++ b/classes/v2.APIKeyUpdateRequest.html @@ -1,3 +1,3 @@ APIKeyUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeyUpdateRequest

Request used to update an API key.

-

Hierarchy

  • APIKeyUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: APIKeyUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • APIKeyUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: APIKeyUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.APIKeysResponse.html b/classes/v2.APIKeysResponse.html index 268f90c39e2..c160801dde9 100644 --- a/classes/v2.APIKeysResponse.html +++ b/classes/v2.APIKeysResponse.html @@ -1,7 +1,7 @@ APIKeysResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeysResponse

Response for a list of API keys.

-

Hierarchy

  • APIKeysResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: PartialAPIKey[]
+

Hierarchy

  • APIKeysResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: PartialAPIKey[]

Array of API keys.

-

Optional included

included?: APIKeyResponseIncludedItem[]
+

Optional included

included?: APIKeyResponseIncludedItem[]

Array of objects related to the API key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApiException.html b/classes/v2.ApiException.html index 5a2f7b786a3..fb710efae12 100644 --- a/classes/v2.ApiException.html +++ b/classes/v2.ApiException.html @@ -4,7 +4,7 @@

Example API returns a ErrorMessageObject whenever HTTP status code is not in [200, 299] => ApiException(404, someErrorMessageObject)

-

Type parameters

  • T

Hierarchy

  • Error
    • ApiException

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: T

code

code: number

message

message: string

name

name: string

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • +

Type parameters

  • T

Hierarchy

  • Error
    • ApiException

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: T

code

code: number

message

message: string

name

name: string

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static Optional prepareStackTrace

  • prepareStackTrace(err: Error, stackTraces: CallSite[]): any

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AppKeyAuthAuthentication.html b/classes/v2.AppKeyAuthAuthentication.html index e89d4937762..cbeda6cffc9 100644 --- a/classes/v2.AppKeyAuthAuthentication.html +++ b/classes/v2.AppKeyAuthAuthentication.html @@ -1,7 +1,7 @@ AppKeyAuthAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppKeyAuthAuthentication

Applies apiKey authentication to the request context.

-

Hierarchy

  • AppKeyAuthAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • AppKeyAuthAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

applySecurityAuthentication

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyCreateAttributes.html b/classes/v2.ApplicationKeyCreateAttributes.html index bf04a20b941..481495a7476 100644 --- a/classes/v2.ApplicationKeyCreateAttributes.html +++ b/classes/v2.ApplicationKeyCreateAttributes.html @@ -1,7 +1,7 @@ ApplicationKeyCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyCreateAttributes

Attributes used to create an application Key.

-

Hierarchy

  • ApplicationKeyCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • ApplicationKeyCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the application key.

-

Optional scopes

scopes?: string[]
+

Optional scopes

scopes?: string[]

Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyCreateData.html b/classes/v2.ApplicationKeyCreateData.html index fa26a6c50e4..17c69d6d562 100644 --- a/classes/v2.ApplicationKeyCreateData.html +++ b/classes/v2.ApplicationKeyCreateData.html @@ -1,3 +1,3 @@ ApplicationKeyCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyCreateData

Object used to create an application key.

-

Hierarchy

  • ApplicationKeyCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: ApplicationKeyCreateAttributes

type

type: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ApplicationKeyCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: ApplicationKeyCreateAttributes

type

type: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyCreateRequest.html b/classes/v2.ApplicationKeyCreateRequest.html index cb536925d0b..56de35607c3 100644 --- a/classes/v2.ApplicationKeyCreateRequest.html +++ b/classes/v2.ApplicationKeyCreateRequest.html @@ -1,3 +1,3 @@ ApplicationKeyCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyCreateRequest

Request used to create an application key.

-

Hierarchy

  • ApplicationKeyCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: ApplicationKeyCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ApplicationKeyCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: ApplicationKeyCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyRelationships.html b/classes/v2.ApplicationKeyRelationships.html index df1d45d6f8a..3c0d553a09c 100644 --- a/classes/v2.ApplicationKeyRelationships.html +++ b/classes/v2.ApplicationKeyRelationships.html @@ -1,3 +1,3 @@ ApplicationKeyRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyRelationships

Resources related to the application key.

-

Hierarchy

  • ApplicationKeyRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ownedBy

ownedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ApplicationKeyRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ownedBy

ownedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyResponse.html b/classes/v2.ApplicationKeyResponse.html index bba5105ddc6..913d34303b4 100644 --- a/classes/v2.ApplicationKeyResponse.html +++ b/classes/v2.ApplicationKeyResponse.html @@ -1,5 +1,5 @@ ApplicationKeyResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyResponse

Response for retrieving an application key.

-

Hierarchy

  • ApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: FullApplicationKey

Optional included

included?: ApplicationKeyResponseIncludedItem[]
+

Hierarchy

  • ApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: FullApplicationKey

Optional included

included?: ApplicationKeyResponseIncludedItem[]

Array of objects related to the application key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyUpdateAttributes.html b/classes/v2.ApplicationKeyUpdateAttributes.html index b923adc2f11..f837a0c5b05 100644 --- a/classes/v2.ApplicationKeyUpdateAttributes.html +++ b/classes/v2.ApplicationKeyUpdateAttributes.html @@ -1,7 +1,7 @@ ApplicationKeyUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyUpdateAttributes

Attributes used to update an application Key.

-

Hierarchy

  • ApplicationKeyUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional name

name?: string
+

Hierarchy

  • ApplicationKeyUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional name

name?: string

Name of the application key.

-

Optional scopes

scopes?: string[]
+

Optional scopes

scopes?: string[]

Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyUpdateData.html b/classes/v2.ApplicationKeyUpdateData.html index 113000012b1..17bc6f3e4c5 100644 --- a/classes/v2.ApplicationKeyUpdateData.html +++ b/classes/v2.ApplicationKeyUpdateData.html @@ -1,5 +1,5 @@ ApplicationKeyUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyUpdateData

Object used to update an application key.

-

Hierarchy

  • ApplicationKeyUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: ApplicationKeyUpdateAttributes

id

id: string
+

Hierarchy

  • ApplicationKeyUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: ApplicationKeyUpdateAttributes

id

id: string

ID of the application key.

-

type

type: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ApplicationKeyUpdateRequest.html b/classes/v2.ApplicationKeyUpdateRequest.html index abc247014b2..d5ffea67e12 100644 --- a/classes/v2.ApplicationKeyUpdateRequest.html +++ b/classes/v2.ApplicationKeyUpdateRequest.html @@ -1,3 +1,3 @@ ApplicationKeyUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationKeyUpdateRequest

Request used to update an application key.

-

Hierarchy

  • ApplicationKeyUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: ApplicationKeyUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ApplicationKeyUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: ApplicationKeyUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMapping.html b/classes/v2.AuthNMapping.html index 2294efab352..6ceb6a56793 100644 --- a/classes/v2.AuthNMapping.html +++ b/classes/v2.AuthNMapping.html @@ -1,7 +1,7 @@ AuthNMapping | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMapping

The AuthN Mapping object returned by API.

-

Hierarchy

  • AuthNMapping

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: AuthNMappingAttributes

id

id: string
+

Hierarchy

  • AuthNMapping

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: AuthNMappingAttributes

id

id: string

ID of the AuthN Mapping.

-

Optional included

included?: AuthNMappingIncluded[]
+

Optional included

included?: AuthNMappingIncluded[]

Included data in the AuthN Mapping response.

-

Optional relationships

relationships?: AuthNMappingRelationships

type

type: "authn_mappings"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: AuthNMappingRelationships

type

type: "authn_mappings"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingAttributes.html b/classes/v2.AuthNMappingAttributes.html index 998d00e1f43..dc29365f3f4 100644 --- a/classes/v2.AuthNMappingAttributes.html +++ b/classes/v2.AuthNMappingAttributes.html @@ -1,13 +1,13 @@ AuthNMappingAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingAttributes

Attributes of AuthN Mapping.

-

Hierarchy

  • AuthNMappingAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string
+

Hierarchy

  • AuthNMappingAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string

Key portion of a key/value pair of the attribute sent from the Identity Provider.

-

Optional attributeValue

attributeValue?: string
+

Optional attributeValue

attributeValue?: string

Value portion of a key/value pair of the attribute sent from the Identity Provider.

-

Optional createdAt

createdAt?: Date
+

Optional createdAt

createdAt?: Date

Creation time of the AuthN Mapping.

-

Optional modifiedAt

modifiedAt?: Date
+

Optional modifiedAt

modifiedAt?: Date

Time of last AuthN Mapping modification.

-

Optional samlAssertionAttributeId

samlAssertionAttributeId?: number
+

Optional samlAssertionAttributeId

samlAssertionAttributeId?: number

The ID of the SAML assertion attribute.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingCreateAttributes.html b/classes/v2.AuthNMappingCreateAttributes.html index 7a17d850dc3..692e6d14369 100644 --- a/classes/v2.AuthNMappingCreateAttributes.html +++ b/classes/v2.AuthNMappingCreateAttributes.html @@ -1,7 +1,7 @@ AuthNMappingCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingCreateAttributes

Key/Value pair of attributes used for create request.

-

Hierarchy

  • AuthNMappingCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string
+

Hierarchy

  • AuthNMappingCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string

Key portion of a key/value pair of the attribute sent from the Identity Provider.

-

Optional attributeValue

attributeValue?: string
+

Optional attributeValue

attributeValue?: string

Value portion of a key/value pair of the attribute sent from the Identity Provider.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingCreateData.html b/classes/v2.AuthNMappingCreateData.html index 34926e05ded..77bfe3deaea 100644 --- a/classes/v2.AuthNMappingCreateData.html +++ b/classes/v2.AuthNMappingCreateData.html @@ -1,3 +1,3 @@ AuthNMappingCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingCreateData

Data for creating an AuthN Mapping.

-

Hierarchy

  • AuthNMappingCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: AuthNMappingCreateAttributes

Optional relationships

relationships?: AuthNMappingCreateRelationships

type

type: "authn_mappings"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: AuthNMappingCreateAttributes

Optional relationships

relationships?: AuthNMappingCreateRelationships

type

type: "authn_mappings"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingCreateRelationships.html b/classes/v2.AuthNMappingCreateRelationships.html index a9b8c500f06..0a7a6852d37 100644 --- a/classes/v2.AuthNMappingCreateRelationships.html +++ b/classes/v2.AuthNMappingCreateRelationships.html @@ -1,3 +1,3 @@ AuthNMappingCreateRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingCreateRelationships

Relationship of AuthN Mapping create object to Role.

-

Hierarchy

  • AuthNMappingCreateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional role

role?: RelationshipToRole

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingCreateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional role

role?: RelationshipToRole

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingCreateRequest.html b/classes/v2.AuthNMappingCreateRequest.html index a0be75aa7bd..c4dcb07619c 100644 --- a/classes/v2.AuthNMappingCreateRequest.html +++ b/classes/v2.AuthNMappingCreateRequest.html @@ -1,3 +1,3 @@ AuthNMappingCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingCreateRequest

Request for creating an AuthN Mapping.

-

Hierarchy

  • AuthNMappingCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: AuthNMappingCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: AuthNMappingCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingRelationships.html b/classes/v2.AuthNMappingRelationships.html index 208fdb80755..5149c0f6112 100644 --- a/classes/v2.AuthNMappingRelationships.html +++ b/classes/v2.AuthNMappingRelationships.html @@ -1,3 +1,3 @@ AuthNMappingRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingRelationships

All relationships associated with AuthN Mapping.

-

Hierarchy

  • AuthNMappingRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional role

role?: RelationshipToRole

Optional samlAssertionAttribute

samlAssertionAttribute?: RelationshipToSAMLAssertionAttribute

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional role

role?: RelationshipToRole

Optional samlAssertionAttribute

samlAssertionAttribute?: RelationshipToSAMLAssertionAttribute

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingResponse.html b/classes/v2.AuthNMappingResponse.html index 6b38c3a7c10..7aebaaaab2f 100644 --- a/classes/v2.AuthNMappingResponse.html +++ b/classes/v2.AuthNMappingResponse.html @@ -1,3 +1,3 @@ AuthNMappingResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingResponse

AuthN Mapping response from the API.

-

Hierarchy

  • AuthNMappingResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: AuthNMapping

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: AuthNMapping

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingUpdateAttributes.html b/classes/v2.AuthNMappingUpdateAttributes.html index 2055dfedc75..be579f17441 100644 --- a/classes/v2.AuthNMappingUpdateAttributes.html +++ b/classes/v2.AuthNMappingUpdateAttributes.html @@ -1,7 +1,7 @@ AuthNMappingUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingUpdateAttributes

Key/Value pair of attributes used for update request.

-

Hierarchy

  • AuthNMappingUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string
+

Hierarchy

  • AuthNMappingUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string

Key portion of a key/value pair of the attribute sent from the Identity Provider.

-

Optional attributeValue

attributeValue?: string
+

Optional attributeValue

attributeValue?: string

Value portion of a key/value pair of the attribute sent from the Identity Provider.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingUpdateData.html b/classes/v2.AuthNMappingUpdateData.html index 63290494e9a..b01b6d30718 100644 --- a/classes/v2.AuthNMappingUpdateData.html +++ b/classes/v2.AuthNMappingUpdateData.html @@ -1,5 +1,5 @@ AuthNMappingUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingUpdateData

Data for updating an AuthN Mapping.

-

Hierarchy

  • AuthNMappingUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: AuthNMappingUpdateAttributes

id

id: string
+

Hierarchy

  • AuthNMappingUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: AuthNMappingUpdateAttributes

id

id: string

ID of the AuthN Mapping.

-

Optional relationships

relationships?: AuthNMappingUpdateRelationships

type

type: "authn_mappings"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: AuthNMappingUpdateRelationships

type

type: "authn_mappings"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingUpdateRelationships.html b/classes/v2.AuthNMappingUpdateRelationships.html index fc5f9f2fd03..cda230ec0a4 100644 --- a/classes/v2.AuthNMappingUpdateRelationships.html +++ b/classes/v2.AuthNMappingUpdateRelationships.html @@ -1,3 +1,3 @@ AuthNMappingUpdateRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingUpdateRelationships

Relationship of AuthN Mapping update object to Role.

-

Hierarchy

  • AuthNMappingUpdateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional role

role?: RelationshipToRole

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingUpdateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional role

role?: RelationshipToRole

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingUpdateRequest.html b/classes/v2.AuthNMappingUpdateRequest.html index fe8ad3f7f94..0d7c97d186f 100644 --- a/classes/v2.AuthNMappingUpdateRequest.html +++ b/classes/v2.AuthNMappingUpdateRequest.html @@ -1,3 +1,3 @@ AuthNMappingUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingUpdateRequest

Request to update an AuthN Mapping.

-

Hierarchy

  • AuthNMappingUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: AuthNMappingUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AuthNMappingUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: AuthNMappingUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthNMappingsApi.html b/classes/v2.AuthNMappingsApi.html index 8e226fa3cb7..44dce5e8ce7 100644 --- a/classes/v2.AuthNMappingsApi.html +++ b/classes/v2.AuthNMappingsApi.html @@ -1,20 +1,20 @@ -AuthNMappingsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthNMappingsApi

Hierarchy

  • AuthNMappingsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AuthNMappingsApi(configuration: v2.Configuration, requestFactory?: AuthNMappingsApiRequestFactory, responseProcessor?: AuthNMappingsApiResponseProcessor): AuthNMappingsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: AuthNMappingsApiRequestFactory

Private responseProcessor

responseProcessor: AuthNMappingsApiResponseProcessor

Methods

createAuthNMapping

deleteAuthNMapping

getAuthNMapping

Returns Promise<void>

getAuthNMapping

listAuthNMappings

Returns Promise<AuthNMappingResponse>

listAuthNMappings

updateAuthNMapping

Returns Promise<AuthNMappingsResponse>

updateAuthNMapping

Optional meta

meta?: v2.ResponseMetaAttributes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.AuthZAuthentication.html b/classes/v2.AuthZAuthentication.html index 82b7fe6495f..1ed4342b7eb 100644 --- a/classes/v2.AuthZAuthentication.html +++ b/classes/v2.AuthZAuthentication.html @@ -1,7 +1,7 @@ AuthZAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthZAuthentication

Applies oauth2 authentication to the request context.

-

Hierarchy

  • AuthZAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • AuthZAuthentication

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

applySecurityAuthentication

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.BaseServerConfiguration.html b/classes/v2.BaseServerConfiguration.html index 70aa8fcf8a8..ecd0a2c50b3 100644 --- a/classes/v2.BaseServerConfiguration.html +++ b/classes/v2.BaseServerConfiguration.html @@ -1,13 +1,13 @@ BaseServerConfiguration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseServerConfiguration

Represents the configuration of a server

-

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getConfiguration

  • getConfiguration(): {}

Private getUrl

  • getUrl(): string

makeRequestContext

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getConfiguration

  • getConfiguration(): {}

Private getUrl

  • getUrl(): string

makeRequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

Returns v2.RequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

Hierarchy

  • CloudWorkloadSecurityAgentRuleCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: CloudWorkloadSecurityAgentRuleCreateAttributes

type

type: "agent_rule"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleCreateRequest.html b/classes/v2.CloudWorkloadSecurityAgentRuleCreateRequest.html index a874c750ee0..55cd526d2eb 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleCreateRequest.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleCreateRequest.html @@ -1,3 +1,3 @@ CloudWorkloadSecurityAgentRuleCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleCreateRequest

Request object that includes the Agent rule to create.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: CloudWorkloadSecurityAgentRuleCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • CloudWorkloadSecurityAgentRuleCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: CloudWorkloadSecurityAgentRuleCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleCreatorAttributes.html b/classes/v2.CloudWorkloadSecurityAgentRuleCreatorAttributes.html index c5dccab332b..e9c19b950cc 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleCreatorAttributes.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleCreatorAttributes.html @@ -1,7 +1,7 @@ CloudWorkloadSecurityAgentRuleCreatorAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleCreatorAttributes

The attributes of the user who created the Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleCreatorAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional handle

handle?: string
+

Hierarchy

  • CloudWorkloadSecurityAgentRuleCreatorAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional handle

handle?: string

The handle of the user.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the user.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleData.html b/classes/v2.CloudWorkloadSecurityAgentRuleData.html index bc0eb482860..7a7f9a237dc 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleData.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleData.html @@ -1,5 +1,5 @@ CloudWorkloadSecurityAgentRuleData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleData

Object for a single Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: CloudWorkloadSecurityAgentRuleAttributes

Optional id

id?: string
+

Hierarchy

  • CloudWorkloadSecurityAgentRuleData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: CloudWorkloadSecurityAgentRuleAttributes

Optional id

id?: string

The ID of the Agent rule.

-

Optional type

type?: "agent_rule"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "agent_rule"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleResponse.html b/classes/v2.CloudWorkloadSecurityAgentRuleResponse.html index f0bb0568fb4..5ae6009f578 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleResponse.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleResponse.html @@ -1,3 +1,3 @@ CloudWorkloadSecurityAgentRuleResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleResponse

Response object that includes an Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: CloudWorkloadSecurityAgentRuleData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • CloudWorkloadSecurityAgentRuleResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: CloudWorkloadSecurityAgentRuleData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleUpdateAttributes.html b/classes/v2.CloudWorkloadSecurityAgentRuleUpdateAttributes.html index 405e5296cc9..56590e2513c 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleUpdateAttributes.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleUpdateAttributes.html @@ -1,9 +1,9 @@ CloudWorkloadSecurityAgentRuleUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleUpdateAttributes

Update an existing Cloud Workload Security Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional description

description?: string
+

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional description

description?: string

The description of the Agent rule.

-

Optional enabled

enabled?: boolean
+

Optional enabled

enabled?: boolean

Whether the Agent rule is enabled.

-

Optional expression

expression?: string
+

Optional expression

expression?: string

The SECL expression of the Agent rule.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleUpdateData.html b/classes/v2.CloudWorkloadSecurityAgentRuleUpdateData.html index 754904c40c0..1b23642231c 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleUpdateData.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleUpdateData.html @@ -1,3 +1,3 @@ CloudWorkloadSecurityAgentRuleUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleUpdateData

Object for a single Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: CloudWorkloadSecurityAgentRuleUpdateAttributes

type

type: "agent_rule"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: CloudWorkloadSecurityAgentRuleUpdateAttributes

type

type: "agent_rule"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleUpdateRequest.html b/classes/v2.CloudWorkloadSecurityAgentRuleUpdateRequest.html index b9b022bd605..cf8f6c84cb3 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleUpdateRequest.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleUpdateRequest.html @@ -1,3 +1,3 @@ CloudWorkloadSecurityAgentRuleUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleUpdateRequest

Request object that includes the Agent rule with the attributes to update.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: CloudWorkloadSecurityAgentRuleUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: CloudWorkloadSecurityAgentRuleUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRuleUpdaterAttributes.html b/classes/v2.CloudWorkloadSecurityAgentRuleUpdaterAttributes.html index a5694204103..5340291ab31 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRuleUpdaterAttributes.html +++ b/classes/v2.CloudWorkloadSecurityAgentRuleUpdaterAttributes.html @@ -1,7 +1,7 @@ CloudWorkloadSecurityAgentRuleUpdaterAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRuleUpdaterAttributes

The attributes of the user who last updated the Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdaterAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional handle

handle?: string
+

Hierarchy

  • CloudWorkloadSecurityAgentRuleUpdaterAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional handle

handle?: string

The handle of the user.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the user.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityAgentRulesListResponse.html b/classes/v2.CloudWorkloadSecurityAgentRulesListResponse.html index 4626f25effd..8ae9527dfe4 100644 --- a/classes/v2.CloudWorkloadSecurityAgentRulesListResponse.html +++ b/classes/v2.CloudWorkloadSecurityAgentRulesListResponse.html @@ -1,5 +1,5 @@ CloudWorkloadSecurityAgentRulesListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityAgentRulesListResponse

Response object that includes a list of Agent rule.

-

Hierarchy

  • CloudWorkloadSecurityAgentRulesListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: CloudWorkloadSecurityAgentRuleData[]
+

Hierarchy

  • CloudWorkloadSecurityAgentRulesListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: CloudWorkloadSecurityAgentRuleData[]

A list of Agent rules objects.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.CloudWorkloadSecurityApi.html b/classes/v2.CloudWorkloadSecurityApi.html index 2617f956675..4e8937ce54e 100644 --- a/classes/v2.CloudWorkloadSecurityApi.html +++ b/classes/v2.CloudWorkloadSecurityApi.html @@ -1,20 +1,20 @@ -CloudWorkloadSecurityApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWorkloadSecurityApi

Hierarchy

  • CloudWorkloadSecurityApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new CloudWorkloadSecurityApi(configuration: v2.Configuration, requestFactory?: CloudWorkloadSecurityApiRequestFactory, responseProcessor?: CloudWorkloadSecurityApiResponseProcessor): CloudWorkloadSecurityApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: CloudWorkloadSecurityApiRequestFactory

Private responseProcessor

responseProcessor: CloudWorkloadSecurityApiResponseProcessor

Methods

createCloudWorkloadSecurityAgentRule

deleteCloudWorkloadSecurityAgentRule

downloadCloudWorkloadPolicyFile

Returns Promise<void>

downloadCloudWorkloadPolicyFile

getCloudWorkloadSecurityAgentRule

getCloudWorkloadSecurityAgentRule

listCloudWorkloadSecurityAgentRules

Returns Promise<CloudWorkloadSecurityAgentRuleResponse>

listCloudWorkloadSecurityAgentRules

updateCloudWorkloadSecurityAgentRule

updateCloudWorkloadSecurityAgentRule

type

type: DashboardType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.DashboardListItemResponse.html b/classes/v2.DashboardListItemResponse.html index 8b89b8696a4..0e861f15a52 100644 --- a/classes/v2.DashboardListItemResponse.html +++ b/classes/v2.DashboardListItemResponse.html @@ -1,5 +1,5 @@ DashboardListItemResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListItemResponse

A dashboard within a list.

-

Hierarchy

  • DashboardListItemResponse

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string
+

Hierarchy

  • DashboardListItemResponse

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string

ID of the dashboard.

-

type

type: DashboardType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: DashboardType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.DashboardListItems.html b/classes/v2.DashboardListItems.html index 6844e749d4c..03e50ac236f 100644 --- a/classes/v2.DashboardListItems.html +++ b/classes/v2.DashboardListItems.html @@ -1,7 +1,7 @@ DashboardListItems | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListItems

Dashboards within a list.

-

Hierarchy

  • DashboardListItems

Index

Constructors

Properties

Constructors

constructor

Properties

dashboards

dashboards: DashboardListItem[]
+

Hierarchy

  • DashboardListItems

Index

Constructors

Properties

Constructors

constructor

Properties

dashboards

dashboards: DashboardListItem[]

List of dashboards in the dashboard list.

-

Optional total

total?: number
+

Optional total

total?: number

Number of dashboards in the dashboard list.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.DashboardListUpdateItemsRequest.html b/classes/v2.DashboardListUpdateItemsRequest.html index 687a83eddcf..c806b34db12 100644 --- a/classes/v2.DashboardListUpdateItemsRequest.html +++ b/classes/v2.DashboardListUpdateItemsRequest.html @@ -1,5 +1,5 @@ DashboardListUpdateItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListUpdateItemsRequest

Request containing the list of dashboards to update to.

-

Hierarchy

  • DashboardListUpdateItemsRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dashboards

dashboards?: DashboardListItemRequest[]
+

Hierarchy

  • DashboardListUpdateItemsRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dashboards

dashboards?: DashboardListItemRequest[]

List of dashboards to update the dashboard list to.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.DashboardListUpdateItemsResponse.html b/classes/v2.DashboardListUpdateItemsResponse.html index b4f69279050..cf1c2da9f91 100644 --- a/classes/v2.DashboardListUpdateItemsResponse.html +++ b/classes/v2.DashboardListUpdateItemsResponse.html @@ -1,5 +1,5 @@ DashboardListUpdateItemsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListUpdateItemsResponse

Response containing a list of updated dashboards.

-

Hierarchy

  • DashboardListUpdateItemsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dashboards

dashboards?: DashboardListItemResponse[]
+

Hierarchy

  • DashboardListUpdateItemsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional dashboards

dashboards?: DashboardListItemResponse[]

List of dashboards in the dashboard list.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.DashboardListsApi.html b/classes/v2.DashboardListsApi.html index b81c97e717a..1d285aa0c87 100644 --- a/classes/v2.DashboardListsApi.html +++ b/classes/v2.DashboardListsApi.html @@ -1,16 +1,16 @@ -DashboardListsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DashboardListsApi

Hierarchy

  • DashboardListsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DashboardListsApi(configuration: v2.Configuration, requestFactory?: DashboardListsApiRequestFactory, responseProcessor?: DashboardListsApiResponseProcessor): v2.DashboardListsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: DashboardListsApiRequestFactory

Private responseProcessor

responseProcessor: DashboardListsApiResponseProcessor

Methods

createDashboardListItems

deleteDashboardListItems

getDashboardListItems

Returns Promise<DashboardListDeleteItemsResponse>

getDashboardListItems

updateDashboardListItems

Returns Promise<DashboardListItems>

updateDashboardListItems

Optional relationships

relationships?: APIKeyRelationships

Optional type

type?: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.FullAPIKeyAttributes.html b/classes/v2.FullAPIKeyAttributes.html index 6f0223a0bf8..ef445eb6a69 100644 --- a/classes/v2.FullAPIKeyAttributes.html +++ b/classes/v2.FullAPIKeyAttributes.html @@ -1,13 +1,13 @@ FullAPIKeyAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FullAPIKeyAttributes

Attributes of a full API key.

-

Hierarchy

  • FullAPIKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string
+

Hierarchy

  • FullAPIKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string

Creation date of the API key.

-

Optional key

key?: string
+

Optional key

key?: string

The API key.

-

Optional last4

last4?: string
+

Optional last4

last4?: string

The last four characters of the API key.

-

Optional modifiedAt

modifiedAt?: string
+

Optional modifiedAt

modifiedAt?: string

Date the API key was last modified.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the API key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.FullApplicationKey.html b/classes/v2.FullApplicationKey.html index 522375db231..1d764841e81 100644 --- a/classes/v2.FullApplicationKey.html +++ b/classes/v2.FullApplicationKey.html @@ -1,5 +1,5 @@ FullApplicationKey | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FullApplicationKey

Datadog application key.

-

Hierarchy

  • FullApplicationKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: FullApplicationKeyAttributes

Optional id

id?: string
+

Hierarchy

  • FullApplicationKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: FullApplicationKeyAttributes

Optional id

id?: string

ID of the application key.

-

Optional relationships

relationships?: ApplicationKeyRelationships

Optional type

type?: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: ApplicationKeyRelationships

Optional type

type?: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.FullApplicationKeyAttributes.html b/classes/v2.FullApplicationKeyAttributes.html index 90452936589..d121ded9730 100644 --- a/classes/v2.FullApplicationKeyAttributes.html +++ b/classes/v2.FullApplicationKeyAttributes.html @@ -1,13 +1,13 @@ FullApplicationKeyAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FullApplicationKeyAttributes

Attributes of a full application key.

-

Hierarchy

  • FullApplicationKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string
+

Hierarchy

  • FullApplicationKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string

Creation date of the application key.

-

Optional key

key?: string
+

Optional key

key?: string

The application key.

-

Optional last4

last4?: string
+

Optional last4

last4?: string

The last four characters of the application key.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the application key.

-

Optional scopes

scopes?: string[]
+

Optional scopes

scopes?: string[]

Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.HTTPLogError.html b/classes/v2.HTTPLogError.html index bcf649a6395..4ab38cfb0c3 100644 --- a/classes/v2.HTTPLogError.html +++ b/classes/v2.HTTPLogError.html @@ -1,9 +1,9 @@ HTTPLogError | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPLogError

List of errors.

-

Hierarchy

  • HTTPLogError

Index

Constructors

Properties

Constructors

constructor

Properties

Optional detail

detail?: string
+

Hierarchy

  • HTTPLogError

Index

Constructors

Properties

Constructors

constructor

Properties

Optional detail

detail?: string

Error message.

-

Optional status

status?: string
+

Optional status

status?: string

Error code.

-

Optional title

title?: string
+

Optional title

title?: string

Error title.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.HTTPLogErrors.html b/classes/v2.HTTPLogErrors.html index 152e78dc13d..3fefefaa880 100644 --- a/classes/v2.HTTPLogErrors.html +++ b/classes/v2.HTTPLogErrors.html @@ -1,5 +1,5 @@ HTTPLogErrors | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPLogErrors

Invalid query performed.

-

Hierarchy

  • HTTPLogErrors

Index

Constructors

Properties

Constructors

constructor

Properties

Optional errors

errors?: v2.HTTPLogError[]
+

Hierarchy

  • HTTPLogErrors

Index

Constructors

Properties

Constructors

constructor

Properties

Optional errors

errors?: v2.HTTPLogError[]

Structured errors.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.HTTPLogItem.html b/classes/v2.HTTPLogItem.html index f96a27e8c97..1ee19bd5382 100644 --- a/classes/v2.HTTPLogItem.html +++ b/classes/v2.HTTPLogItem.html @@ -1,13 +1,13 @@ HTTPLogItem | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPLogItem

Logs that are sent over HTTP.

-

Hierarchy

  • HTTPLogItem

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ddsource

ddsource?: string
+

Hierarchy

  • HTTPLogItem

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ddsource

ddsource?: string

The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. See reserved attributes.

-

Optional ddtags

ddtags?: string
+

Optional ddtags

ddtags?: string

Tags associated with your logs.

-

Optional hostname

hostname?: string
+

Optional hostname

hostname?: string

The name of the originating host of the log.

-

Optional message

message?: string
+

Optional message

message?: string

The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.

-

Optional service

service?: string
+

Optional service

service?: string

The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. See reserved attributes.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.HttpException.html b/classes/v2.HttpException.html index 1f2d736ad87..34fb558c0f4 100644 --- a/classes/v2.HttpException.html +++ b/classes/v2.HttpException.html @@ -1,4 +1,4 @@ -HttpException | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpException

Hierarchy

  • Error
    • HttpException

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Hierarchy

  • IncidentCreateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

commanderUser

commanderUser: NullableRelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentCreateRequest.html b/classes/v2.IncidentCreateRequest.html index eedf14f5d67..a37f48a72a7 100644 --- a/classes/v2.IncidentCreateRequest.html +++ b/classes/v2.IncidentCreateRequest.html @@ -1,3 +1,3 @@ IncidentCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentCreateRequest

Create request for an incident.

-

Hierarchy

  • IncidentCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentFieldAttributesMultipleValue.html b/classes/v2.IncidentFieldAttributesMultipleValue.html index ad3b5434010..b17b6c821c7 100644 --- a/classes/v2.IncidentFieldAttributesMultipleValue.html +++ b/classes/v2.IncidentFieldAttributesMultipleValue.html @@ -1,5 +1,5 @@ IncidentFieldAttributesMultipleValue | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentFieldAttributesMultipleValue

A field with potentially multiple values selected.

-

Hierarchy

  • IncidentFieldAttributesMultipleValue

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: IncidentFieldAttributesValueType

Optional value

value?: string[]
+

Hierarchy

  • IncidentFieldAttributesMultipleValue

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: IncidentFieldAttributesValueType

Optional value

value?: string[]

The multiple values selected for this field.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentFieldAttributesSingleValue.html b/classes/v2.IncidentFieldAttributesSingleValue.html index d699923a418..8113d889467 100644 --- a/classes/v2.IncidentFieldAttributesSingleValue.html +++ b/classes/v2.IncidentFieldAttributesSingleValue.html @@ -1,5 +1,5 @@ IncidentFieldAttributesSingleValue | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentFieldAttributesSingleValue

A field with a single value selected.

-

Hierarchy

  • IncidentFieldAttributesSingleValue

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: IncidentFieldAttributesSingleValueType

Optional value

value?: string
+

Hierarchy

  • IncidentFieldAttributesSingleValue

Index

Constructors

Properties

Constructors

constructor

Properties

Optional type

type?: IncidentFieldAttributesSingleValueType

Optional value

value?: string

The single value selected for this field.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentNotificationHandle.html b/classes/v2.IncidentNotificationHandle.html index 8ec2cb38fc3..f8128697def 100644 --- a/classes/v2.IncidentNotificationHandle.html +++ b/classes/v2.IncidentNotificationHandle.html @@ -1,7 +1,7 @@ IncidentNotificationHandle | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentNotificationHandle

A notification handle that will be notified at incident creation.

-

Hierarchy

  • IncidentNotificationHandle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional displayName

displayName?: string
+

Hierarchy

  • IncidentNotificationHandle

Index

Constructors

Properties

Constructors

constructor

Properties

Optional displayName

displayName?: string

The name of the notified handle.

-

Optional handle

handle?: string
+

Optional handle

handle?: string

The email address used for the notification.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentResponse.html b/classes/v2.IncidentResponse.html index 952473d575b..ccb3ad019f9 100644 --- a/classes/v2.IncidentResponse.html +++ b/classes/v2.IncidentResponse.html @@ -1,5 +1,5 @@ IncidentResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentResponse

Response with an incident.

-

Hierarchy

  • IncidentResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentResponseData

Optional included

included?: IncidentResponseIncludedItem[]
+

Hierarchy

  • IncidentResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentResponseData

Optional included

included?: IncidentResponseIncludedItem[]

Included related resources that the user requested.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentResponseAttributes.html b/classes/v2.IncidentResponseAttributes.html index b21302ca4e1..7b5c71ec0dd 100644 --- a/classes/v2.IncidentResponseAttributes.html +++ b/classes/v2.IncidentResponseAttributes.html @@ -1,39 +1,39 @@ IncidentResponseAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentResponseAttributes

The incident's attributes from a response.

-

Hierarchy

  • IncidentResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date
+

Hierarchy

  • IncidentResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date

Timestamp when the incident was created.

-

Optional customerImpactDuration

customerImpactDuration?: number
+

Optional customerImpactDuration

customerImpactDuration?: number

Length of the incident's customer impact in seconds. Equals the difference between customer_impact_start and customer_impact_end.

-

Optional customerImpactEnd

customerImpactEnd?: Date
+

Optional customerImpactEnd

customerImpactEnd?: Date

Timestamp when customers were no longer impacted by the incident.

-

Optional customerImpactScope

customerImpactScope?: string
+

Optional customerImpactScope

customerImpactScope?: string

A summary of the impact customers experienced during the incident.

-

Optional customerImpactStart

customerImpactStart?: Date
+

Optional customerImpactStart

customerImpactStart?: Date

Timestamp when customers began being impacted by the incident.

-

Optional customerImpacted

customerImpacted?: boolean
+

Optional customerImpacted

customerImpacted?: boolean

A flag indicating whether the incident caused customer impact.

-

Optional detected

detected?: Date
+

Optional detected

detected?: Date

Timestamp when the incident was detected.

-

Optional fields

fields?: {}
+

Optional fields

fields?: {}

A condensed view of the user-defined fields attached to incidents.

-

Type declaration

Optional modified

modified?: Date
+

Type declaration

Optional modified

modified?: Date

Timestamp when the incident was last modified.

-

Optional notificationHandles

notificationHandles?: IncidentNotificationHandle[]
+

Optional notificationHandles

notificationHandles?: IncidentNotificationHandle[]

Notification handles that will be notified of the incident during update.

-

Optional postmortemId

postmortemId?: string
+

Optional postmortemId

postmortemId?: string

The UUID of the postmortem object attached to the incident.

-

Optional publicId

publicId?: number
+

Optional publicId

publicId?: number

The monotonically increasing integer ID for the incident.

-

Optional resolved

resolved?: Date
+

Optional resolved

resolved?: Date

Timestamp when the incident's state was set to resolved.

-

Optional timeToDetect

timeToDetect?: number
+

Optional timeToDetect

timeToDetect?: number

The amount of time in seconds to detect the incident. Equals the difference between customer_impact_start and detected.

-

Optional timeToInternalResponse

timeToInternalResponse?: number
+

Optional timeToInternalResponse

timeToInternalResponse?: number

The amount of time in seconds to call incident after detection. Equals the difference of detected and created.

-

Optional timeToRepair

timeToRepair?: number
+

Optional timeToRepair

timeToRepair?: number

The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.

-

Optional timeToResolve

timeToResolve?: number
+

Optional timeToResolve

timeToResolve?: number

The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.

-

title

title: string
+

title

title: string

The title of the incident, which summarizes what happened.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentResponseData.html b/classes/v2.IncidentResponseData.html index 3073a578f19..9118f7a1670 100644 --- a/classes/v2.IncidentResponseData.html +++ b/classes/v2.IncidentResponseData.html @@ -1,5 +1,5 @@ IncidentResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentResponseData

Incident data from a response.

-

Hierarchy

  • IncidentResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentResponseAttributes

id

id: string
+

Hierarchy

  • IncidentResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentResponseAttributes

id

id: string

The incident's ID.

-

Optional relationships

relationships?: IncidentResponseRelationships

type

type: "incidents"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: IncidentResponseRelationships

type

type: "incidents"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentResponseMeta.html b/classes/v2.IncidentResponseMeta.html index d6607475e37..fe8e25c66ca 100644 --- a/classes/v2.IncidentResponseMeta.html +++ b/classes/v2.IncidentResponseMeta.html @@ -1,3 +1,3 @@ IncidentResponseMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentResponseMeta

The metadata object containing pagination metadata.

-

Hierarchy

  • IncidentResponseMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional pagination

pagination?: IncidentResponseMetaPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentResponseMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional pagination

pagination?: IncidentResponseMetaPagination

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentResponseMetaPagination.html b/classes/v2.IncidentResponseMetaPagination.html index 31d4d54995d..8ee4de07fa0 100644 --- a/classes/v2.IncidentResponseMetaPagination.html +++ b/classes/v2.IncidentResponseMetaPagination.html @@ -1,9 +1,9 @@ IncidentResponseMetaPagination | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentResponseMetaPagination

Pagination properties.

-

Hierarchy

  • IncidentResponseMetaPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional nextOffset

nextOffset?: number
+

Hierarchy

  • IncidentResponseMetaPagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional nextOffset

nextOffset?: number

The index of the first element in the next page of results. Equal to page size added to the current offset.

-

Optional offset

offset?: number
+

Optional offset

offset?: number

The index of the first element in the results.

-

Optional size

size?: number
+

Optional size

size?: number

Maximum size of pages to return.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentResponseRelationships.html b/classes/v2.IncidentResponseRelationships.html index 318547fa745..2d89e1c2be0 100644 --- a/classes/v2.IncidentResponseRelationships.html +++ b/classes/v2.IncidentResponseRelationships.html @@ -1,3 +1,3 @@ IncidentResponseRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentResponseRelationships

The incident's relationships from a response.

-

Hierarchy

  • IncidentResponseRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional commanderUser

commanderUser?: NullableRelationshipToUser

Optional createdByUser

createdByUser?: RelationshipToUser

Optional integrations

integrations?: RelationshipToIncidentIntegrationMetadatas

Optional lastModifiedByUser

lastModifiedByUser?: RelationshipToUser

Optional postmortem

postmortem?: RelationshipToIncidentPostmortem

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentResponseRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional commanderUser

commanderUser?: NullableRelationshipToUser

Optional createdByUser

createdByUser?: RelationshipToUser

Optional integrations

integrations?: RelationshipToIncidentIntegrationMetadatas

Optional lastModifiedByUser

lastModifiedByUser?: RelationshipToUser

Optional postmortem

postmortem?: RelationshipToIncidentPostmortem

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceCreateAttributes.html b/classes/v2.IncidentServiceCreateAttributes.html index 1a330206752..7fae418385f 100644 --- a/classes/v2.IncidentServiceCreateAttributes.html +++ b/classes/v2.IncidentServiceCreateAttributes.html @@ -1,5 +1,5 @@ IncidentServiceCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceCreateAttributes

The incident service's attributes for a create request.

-

Hierarchy

  • IncidentServiceCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • IncidentServiceCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the incident service.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceCreateData.html b/classes/v2.IncidentServiceCreateData.html index 50646325659..46956937cb5 100644 --- a/classes/v2.IncidentServiceCreateData.html +++ b/classes/v2.IncidentServiceCreateData.html @@ -1,3 +1,3 @@ IncidentServiceCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceCreateData

Incident Service payload for create requests.

-

Hierarchy

  • IncidentServiceCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentServiceCreateAttributes

Optional relationships

relationships?: IncidentServiceRelationships

type

type: "services"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentServiceCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentServiceCreateAttributes

Optional relationships

relationships?: IncidentServiceRelationships

type

type: "services"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceCreateRequest.html b/classes/v2.IncidentServiceCreateRequest.html index 3ca717be5ac..18453b196b8 100644 --- a/classes/v2.IncidentServiceCreateRequest.html +++ b/classes/v2.IncidentServiceCreateRequest.html @@ -1,3 +1,3 @@ IncidentServiceCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceCreateRequest

Create request with an incident service payload.

-

Hierarchy

  • IncidentServiceCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentServiceCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentServiceCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentServiceCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceRelationships.html b/classes/v2.IncidentServiceRelationships.html index a463019b375..4f3d16e1c72 100644 --- a/classes/v2.IncidentServiceRelationships.html +++ b/classes/v2.IncidentServiceRelationships.html @@ -1,3 +1,3 @@ IncidentServiceRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceRelationships

The incident service's relationships.

-

Hierarchy

  • IncidentServiceRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdBy

createdBy?: RelationshipToUser

Optional lastModifiedBy

lastModifiedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentServiceRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdBy

createdBy?: RelationshipToUser

Optional lastModifiedBy

lastModifiedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceResponse.html b/classes/v2.IncidentServiceResponse.html index 59905214e0f..f5ce2d7139f 100644 --- a/classes/v2.IncidentServiceResponse.html +++ b/classes/v2.IncidentServiceResponse.html @@ -1,5 +1,5 @@ IncidentServiceResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceResponse

Response with an incident service payload.

-

Hierarchy

  • IncidentServiceResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentServiceResponseData

Optional included

included?: IncidentServiceIncludedItems[]
+

Hierarchy

  • IncidentServiceResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentServiceResponseData

Optional included

included?: IncidentServiceIncludedItems[]

Included objects from relationships.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceResponseAttributes.html b/classes/v2.IncidentServiceResponseAttributes.html index 0fccb18e9c6..21e381008f0 100644 --- a/classes/v2.IncidentServiceResponseAttributes.html +++ b/classes/v2.IncidentServiceResponseAttributes.html @@ -1,9 +1,9 @@ IncidentServiceResponseAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceResponseAttributes

The incident service's attributes from a response.

-

Hierarchy

  • IncidentServiceResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date
+

Hierarchy

  • IncidentServiceResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date

Timestamp of when the incident service was created.

-

Optional modified

modified?: Date
+

Optional modified

modified?: Date

Timestamp of when the incident service was modified.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the incident service.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceResponseData.html b/classes/v2.IncidentServiceResponseData.html index 1cd90f32cd4..1bf8aa876ff 100644 --- a/classes/v2.IncidentServiceResponseData.html +++ b/classes/v2.IncidentServiceResponseData.html @@ -1,5 +1,5 @@ IncidentServiceResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceResponseData

Incident Service data from responses.

-

Hierarchy

  • IncidentServiceResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentServiceResponseAttributes

id

id: string
+

Hierarchy

  • IncidentServiceResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentServiceResponseAttributes

id

id: string

The incident service's ID.

-

Optional relationships

relationships?: IncidentServiceRelationships

type

type: "services"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: IncidentServiceRelationships

type

type: "services"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceUpdateAttributes.html b/classes/v2.IncidentServiceUpdateAttributes.html index cdd6a138556..f9a0136148e 100644 --- a/classes/v2.IncidentServiceUpdateAttributes.html +++ b/classes/v2.IncidentServiceUpdateAttributes.html @@ -1,5 +1,5 @@ IncidentServiceUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceUpdateAttributes

The incident service's attributes for an update request.

-

Hierarchy

  • IncidentServiceUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • IncidentServiceUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the incident service.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceUpdateData.html b/classes/v2.IncidentServiceUpdateData.html index a184bd8df59..c22ac5b566d 100644 --- a/classes/v2.IncidentServiceUpdateData.html +++ b/classes/v2.IncidentServiceUpdateData.html @@ -1,5 +1,5 @@ IncidentServiceUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceUpdateData

Incident Service payload for update requests.

-

Hierarchy

  • IncidentServiceUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentServiceUpdateAttributes

Optional id

id?: string
+

Hierarchy

  • IncidentServiceUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentServiceUpdateAttributes

Optional id

id?: string

The incident service's ID.

-

Optional relationships

relationships?: IncidentServiceRelationships

type

type: "services"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: IncidentServiceRelationships

type

type: "services"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServiceUpdateRequest.html b/classes/v2.IncidentServiceUpdateRequest.html index 2447adbc6c9..36a74e3f69e 100644 --- a/classes/v2.IncidentServiceUpdateRequest.html +++ b/classes/v2.IncidentServiceUpdateRequest.html @@ -1,3 +1,3 @@ IncidentServiceUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServiceUpdateRequest

Update request with an incident service payload.

-

Hierarchy

  • IncidentServiceUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentServiceUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentServiceUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentServiceUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentServicesApi.html b/classes/v2.IncidentServicesApi.html index 902980e4675..22a7ac52887 100644 --- a/classes/v2.IncidentServicesApi.html +++ b/classes/v2.IncidentServicesApi.html @@ -1,20 +1,20 @@ -IncidentServicesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentServicesApi

Hierarchy

  • IncidentServicesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new IncidentServicesApi(configuration: v2.Configuration, requestFactory?: IncidentServicesApiRequestFactory, responseProcessor?: IncidentServicesApiResponseProcessor): IncidentServicesApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: IncidentServicesApiRequestFactory

Private responseProcessor

responseProcessor: IncidentServicesApiResponseProcessor

Methods

createIncidentService

deleteIncidentService

getIncidentService

Returns Promise<void>

getIncidentService

listIncidentServices

Returns Promise<IncidentServiceResponse>

listIncidentServices

updateIncidentService

Returns Promise<IncidentServicesResponse>

updateIncidentService

Optional meta

meta?: IncidentResponseMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamCreateAttributes.html b/classes/v2.IncidentTeamCreateAttributes.html index 7541aabb341..f0bacbaa38d 100644 --- a/classes/v2.IncidentTeamCreateAttributes.html +++ b/classes/v2.IncidentTeamCreateAttributes.html @@ -1,5 +1,5 @@ IncidentTeamCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamCreateAttributes

The incident team's attributes for a create request.

-

Hierarchy

  • IncidentTeamCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • IncidentTeamCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the incident team.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamCreateData.html b/classes/v2.IncidentTeamCreateData.html index 0b3df24f10b..6696891782d 100644 --- a/classes/v2.IncidentTeamCreateData.html +++ b/classes/v2.IncidentTeamCreateData.html @@ -1,3 +1,3 @@ IncidentTeamCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamCreateData

Incident Team data for a create request.

-

Hierarchy

  • IncidentTeamCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentTeamCreateAttributes

Optional relationships

relationships?: IncidentTeamRelationships

type

type: "teams"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentTeamCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentTeamCreateAttributes

Optional relationships

relationships?: IncidentTeamRelationships

type

type: "teams"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamCreateRequest.html b/classes/v2.IncidentTeamCreateRequest.html index 0f49a8ed3fb..2a0ff8b8727 100644 --- a/classes/v2.IncidentTeamCreateRequest.html +++ b/classes/v2.IncidentTeamCreateRequest.html @@ -1,3 +1,3 @@ IncidentTeamCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamCreateRequest

Create request with an incident team payload.

-

Hierarchy

  • IncidentTeamCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentTeamCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentTeamCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentTeamCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamRelationships.html b/classes/v2.IncidentTeamRelationships.html index c1ecbf795da..fd3c7ec20df 100644 --- a/classes/v2.IncidentTeamRelationships.html +++ b/classes/v2.IncidentTeamRelationships.html @@ -1,3 +1,3 @@ IncidentTeamRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamRelationships

The incident team's relationships.

-

Hierarchy

  • IncidentTeamRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdBy

createdBy?: RelationshipToUser

Optional lastModifiedBy

lastModifiedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentTeamRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdBy

createdBy?: RelationshipToUser

Optional lastModifiedBy

lastModifiedBy?: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamResponse.html b/classes/v2.IncidentTeamResponse.html index 027a2e40bc8..08c53d50759 100644 --- a/classes/v2.IncidentTeamResponse.html +++ b/classes/v2.IncidentTeamResponse.html @@ -1,5 +1,5 @@ IncidentTeamResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamResponse

Response with an incident team payload.

-

Hierarchy

  • IncidentTeamResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentTeamResponseData

Optional included

included?: IncidentTeamIncludedItems[]
+

Hierarchy

  • IncidentTeamResponse

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentTeamResponseData

Optional included

included?: IncidentTeamIncludedItems[]

Included objects from relationships.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamResponseAttributes.html b/classes/v2.IncidentTeamResponseAttributes.html index fe8e43846f3..60a1774a44a 100644 --- a/classes/v2.IncidentTeamResponseAttributes.html +++ b/classes/v2.IncidentTeamResponseAttributes.html @@ -1,9 +1,9 @@ IncidentTeamResponseAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamResponseAttributes

The incident team's attributes from a response.

-

Hierarchy

  • IncidentTeamResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date
+

Hierarchy

  • IncidentTeamResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date

Timestamp of when the incident team was created.

-

Optional modified

modified?: Date
+

Optional modified

modified?: Date

Timestamp of when the incident team was modified.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the incident team.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamResponseData.html b/classes/v2.IncidentTeamResponseData.html index ec658f616b3..874889a1730 100644 --- a/classes/v2.IncidentTeamResponseData.html +++ b/classes/v2.IncidentTeamResponseData.html @@ -1,5 +1,5 @@ IncidentTeamResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamResponseData

Incident Team data from a response.

-

Hierarchy

  • IncidentTeamResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentTeamResponseAttributes

Optional id

id?: string
+

Hierarchy

  • IncidentTeamResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentTeamResponseAttributes

Optional id

id?: string

The incident team's ID.

-

Optional relationships

relationships?: IncidentTeamRelationships

Optional type

type?: "teams"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: IncidentTeamRelationships

Optional type

type?: "teams"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamUpdateAttributes.html b/classes/v2.IncidentTeamUpdateAttributes.html index 6211a1a7e3a..1b7219dac1d 100644 --- a/classes/v2.IncidentTeamUpdateAttributes.html +++ b/classes/v2.IncidentTeamUpdateAttributes.html @@ -1,5 +1,5 @@ IncidentTeamUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamUpdateAttributes

The incident team's attributes for an update request.

-

Hierarchy

  • IncidentTeamUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • IncidentTeamUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the incident team.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamUpdateData.html b/classes/v2.IncidentTeamUpdateData.html index c374299475f..bb360c9d23f 100644 --- a/classes/v2.IncidentTeamUpdateData.html +++ b/classes/v2.IncidentTeamUpdateData.html @@ -1,5 +1,5 @@ IncidentTeamUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamUpdateData

Incident Team data for an update request.

-

Hierarchy

  • IncidentTeamUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentTeamUpdateAttributes

Optional id

id?: string
+

Hierarchy

  • IncidentTeamUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentTeamUpdateAttributes

Optional id

id?: string

The incident team's ID.

-

Optional relationships

relationships?: IncidentTeamRelationships

type

type: "teams"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: IncidentTeamRelationships

type

type: "teams"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamUpdateRequest.html b/classes/v2.IncidentTeamUpdateRequest.html index ea959fc1abc..09143469903 100644 --- a/classes/v2.IncidentTeamUpdateRequest.html +++ b/classes/v2.IncidentTeamUpdateRequest.html @@ -1,3 +1,3 @@ IncidentTeamUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamUpdateRequest

Update request with an incident team payload.

-

Hierarchy

  • IncidentTeamUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentTeamUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentTeamUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentTeamUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTeamsApi.html b/classes/v2.IncidentTeamsApi.html index f244b22b1d1..7b50507265b 100644 --- a/classes/v2.IncidentTeamsApi.html +++ b/classes/v2.IncidentTeamsApi.html @@ -1,20 +1,20 @@ -IncidentTeamsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTeamsApi

Hierarchy

  • IncidentTeamsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new IncidentTeamsApi(configuration: v2.Configuration, requestFactory?: IncidentTeamsApiRequestFactory, responseProcessor?: IncidentTeamsApiResponseProcessor): IncidentTeamsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: IncidentTeamsApiRequestFactory

Private responseProcessor

responseProcessor: IncidentTeamsApiResponseProcessor

Methods

createIncidentTeam

deleteIncidentTeam

getIncidentTeam

Returns Promise<void>

getIncidentTeam

listIncidentTeams

Returns Promise<IncidentTeamResponse>

listIncidentTeams

updateIncidentTeam

Returns Promise<IncidentTeamsResponse>

updateIncidentTeam

Optional meta

meta?: IncidentResponseMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTimelineCellMarkdownCreateAttributes.html b/classes/v2.IncidentTimelineCellMarkdownCreateAttributes.html index 745b40ce9b4..2272492a828 100644 --- a/classes/v2.IncidentTimelineCellMarkdownCreateAttributes.html +++ b/classes/v2.IncidentTimelineCellMarkdownCreateAttributes.html @@ -1,5 +1,5 @@ IncidentTimelineCellMarkdownCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTimelineCellMarkdownCreateAttributes

Timeline cell data for Markdown timeline cells for a create request.

-

Hierarchy

  • IncidentTimelineCellMarkdownCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

cellType

cellType: "markdown"

content

content: IncidentTimelineCellMarkdownCreateAttributesContent

Optional important

important?: boolean
+

Hierarchy

  • IncidentTimelineCellMarkdownCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

cellType

cellType: "markdown"

content

content: IncidentTimelineCellMarkdownCreateAttributesContent

Optional important

important?: boolean

A flag indicating whether the timeline cell is important and should be highlighted.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentTimelineCellMarkdownCreateAttributesContent.html b/classes/v2.IncidentTimelineCellMarkdownCreateAttributesContent.html index 1a86c8d64e6..8d460ff74b3 100644 --- a/classes/v2.IncidentTimelineCellMarkdownCreateAttributesContent.html +++ b/classes/v2.IncidentTimelineCellMarkdownCreateAttributesContent.html @@ -1,5 +1,5 @@ IncidentTimelineCellMarkdownCreateAttributesContent | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentTimelineCellMarkdownCreateAttributesContent

The Markdown timeline cell contents.

-

Hierarchy

  • IncidentTimelineCellMarkdownCreateAttributesContent

Index

Constructors

Properties

Constructors

constructor

Properties

Optional content

content?: string
+

Hierarchy

  • IncidentTimelineCellMarkdownCreateAttributesContent

Index

Constructors

Properties

Constructors

constructor

Properties

Optional content

content?: string

The Markdown content of the cell.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentUpdateAttributes.html b/classes/v2.IncidentUpdateAttributes.html index 5ffad64b8b5..fe14c371712 100644 --- a/classes/v2.IncidentUpdateAttributes.html +++ b/classes/v2.IncidentUpdateAttributes.html @@ -1,21 +1,21 @@ IncidentUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentUpdateAttributes

The incident's attributes for an update request.

-

Hierarchy

  • IncidentUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customerImpactEnd

customerImpactEnd?: Date
+

Hierarchy

  • IncidentUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional customerImpactEnd

customerImpactEnd?: Date

Timestamp when customers were no longer impacted by the incident.

-

Optional customerImpactScope

customerImpactScope?: string
+

Optional customerImpactScope

customerImpactScope?: string

A summary of the impact customers experienced during the incident.

-

Optional customerImpactStart

customerImpactStart?: Date
+

Optional customerImpactStart

customerImpactStart?: Date

Timestamp when customers began being impacted by the incident.

-

Optional customerImpacted

customerImpacted?: boolean
+

Optional customerImpacted

customerImpacted?: boolean

A flag indicating whether the incident caused customer impact.

-

Optional detected

detected?: Date
+

Optional detected

detected?: Date

Timestamp when the incident was detected.

-

Optional fields

fields?: {}
+

Optional fields

fields?: {}

A condensed view of the user-defined fields for which to update selections.

-

Type declaration

Optional notificationHandles

notificationHandles?: IncidentNotificationHandle[]
+

Type declaration

Optional notificationHandles

notificationHandles?: IncidentNotificationHandle[]

Notification handles that will be notified of the incident during update.

-

Optional resolved

resolved?: Date
+

Optional resolved

resolved?: Date

Timestamp when the incident's state was set to resolved.

-

Optional title

title?: string
+

Optional title

title?: string

The title of the incident, which summarizes what happened.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentUpdateData.html b/classes/v2.IncidentUpdateData.html index 2d730753000..8eaf0ff61d4 100644 --- a/classes/v2.IncidentUpdateData.html +++ b/classes/v2.IncidentUpdateData.html @@ -1,5 +1,5 @@ IncidentUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentUpdateData

Incident data for an update request.

-

Hierarchy

  • IncidentUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentUpdateAttributes

id

id: string
+

Hierarchy

  • IncidentUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: IncidentUpdateAttributes

id

id: string

The team's ID.

-

Optional relationships

relationships?: IncidentUpdateRelationships

type

type: "incidents"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: IncidentUpdateRelationships

type

type: "incidents"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentUpdateRelationships.html b/classes/v2.IncidentUpdateRelationships.html index 21ae9abf0ad..faf18790b8d 100644 --- a/classes/v2.IncidentUpdateRelationships.html +++ b/classes/v2.IncidentUpdateRelationships.html @@ -1,3 +1,3 @@ IncidentUpdateRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentUpdateRelationships

The incident's relationships for an update request.

-

Hierarchy

  • IncidentUpdateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional commanderUser

commanderUser?: NullableRelationshipToUser

Optional integrations

integrations?: RelationshipToIncidentIntegrationMetadatas

Optional postmortem

postmortem?: RelationshipToIncidentPostmortem

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentUpdateRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional commanderUser

commanderUser?: NullableRelationshipToUser

Optional integrations

integrations?: RelationshipToIncidentIntegrationMetadatas

Optional postmortem

postmortem?: RelationshipToIncidentPostmortem

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentUpdateRequest.html b/classes/v2.IncidentUpdateRequest.html index 882d672b6c6..26cdca2e3b2 100644 --- a/classes/v2.IncidentUpdateRequest.html +++ b/classes/v2.IncidentUpdateRequest.html @@ -1,3 +1,3 @@ IncidentUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentUpdateRequest

Update request for an incident.

-

Hierarchy

  • IncidentUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IncidentUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: IncidentUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IncidentsApi.html b/classes/v2.IncidentsApi.html index d5e69f5ad47..da545c661f5 100644 --- a/classes/v2.IncidentsApi.html +++ b/classes/v2.IncidentsApi.html @@ -1,20 +1,20 @@ -IncidentsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncidentsApi

Hierarchy

  • IncidentsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new IncidentsApi(configuration: v2.Configuration, requestFactory?: IncidentsApiRequestFactory, responseProcessor?: IncidentsApiResponseProcessor): IncidentsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: IncidentsApiRequestFactory

Private responseProcessor

responseProcessor: IncidentsApiResponseProcessor

Methods

createIncident

deleteIncident

getIncident

Returns Promise<void>

getIncident

listIncidents

Returns Promise<IncidentResponse>

listIncidents

updateIncident

Returns Promise<IncidentsResponse>

updateIncident

Optional meta

meta?: IncidentResponseMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.IsomorphicFetchHttpLibrary.html b/classes/v2.IsomorphicFetchHttpLibrary.html index 6b7d72ff114..e43c395ec62 100644 --- a/classes/v2.IsomorphicFetchHttpLibrary.html +++ b/classes/v2.IsomorphicFetchHttpLibrary.html @@ -1 +1 @@ -IsomorphicFetchHttpLibrary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IsomorphicFetchHttpLibrary

Hierarchy

  • IsomorphicFetchHttpLibrary

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

debug

debug: boolean = false

Methods

Private logRequest

Private logResponse

send

Legend

  • Constructor
  • Property
  • Method
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +IsomorphicFetchHttpLibrary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IsomorphicFetchHttpLibrary

Hierarchy

  • IsomorphicFetchHttpLibrary

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

debug

debug: boolean = false

Methods

Private logRequest

Private logResponse

send

Legend

  • Constructor
  • Property
  • Method
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.KeyManagementApi.html b/classes/v2.KeyManagementApi.html index 0c321dcad8c..a81a8d456ce 100644 --- a/classes/v2.KeyManagementApi.html +++ b/classes/v2.KeyManagementApi.html @@ -1,56 +1,56 @@ -KeyManagementApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeyManagementApi

Hierarchy

  • KeyManagementApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new KeyManagementApi(configuration: v2.Configuration, requestFactory?: KeyManagementApiRequestFactory, responseProcessor?: KeyManagementApiResponseProcessor): v2.KeyManagementApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: KeyManagementApiRequestFactory

Private responseProcessor

responseProcessor: KeyManagementApiResponseProcessor

Methods

createAPIKey

createCurrentUserApplicationKey

deleteAPIKey

Returns Promise<v2.ApplicationKeyResponse>

deleteAPIKey

deleteApplicationKey

Returns Promise<void>

deleteApplicationKey

deleteCurrentUserApplicationKey

Returns Promise<void>

deleteCurrentUserApplicationKey

getAPIKey

Returns Promise<void>

getAPIKey

getApplicationKey

Returns Promise<APIKeyResponse>

getApplicationKey

getCurrentUserApplicationKey

Returns Promise<v2.ApplicationKeyResponse>

getCurrentUserApplicationKey

listAPIKeys

Returns Promise<v2.ApplicationKeyResponse>

listAPIKeys

listApplicationKeys

Returns Promise<APIKeysResponse>

listApplicationKeys

listCurrentUserApplicationKeys

Returns Promise<ListApplicationKeysResponse>

listCurrentUserApplicationKeys

updateAPIKey

Returns Promise<ListApplicationKeysResponse>

updateAPIKey

updateApplicationKey

Returns Promise<APIKeyResponse>

updateApplicationKey

updateCurrentUserApplicationKey

Returns Promise<v2.ApplicationKeyResponse>

updateCurrentUserApplicationKey

Optional type

type?: "log"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogAttributes.html b/classes/v2.LogAttributes.html index 42f641bfbaf..643c6bb1ba1 100644 --- a/classes/v2.LogAttributes.html +++ b/classes/v2.LogAttributes.html @@ -1,17 +1,17 @@ LogAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogAttributes

JSON object containing all log attributes and their associated values.

-

Hierarchy

  • LogAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: {}
+

Hierarchy

  • LogAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: {}

JSON object of attributes from your log.

-

Type declaration

  • [key: string]: any

Optional host

host?: string
+

Type declaration

  • [key: string]: any

Optional host

host?: string

Name of the machine from where the logs are being sent.

-

Optional message

message?: string
+

Optional message

message?: string

The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.

-

Optional service

service?: string
+

Optional service

service?: string

The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products.

-

Optional status

status?: string
+

Optional status

status?: string

Status of the message associated with your log.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

Array of tags associated with your log.

-

Optional timestamp

timestamp?: Date
+

Optional timestamp

timestamp?: Date

Timestamp of your log.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateBucket.html b/classes/v2.LogsAggregateBucket.html index 2b770f93d22..aff3cd66646 100644 --- a/classes/v2.LogsAggregateBucket.html +++ b/classes/v2.LogsAggregateBucket.html @@ -1,7 +1,7 @@ LogsAggregateBucket | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateBucket

A bucket values

-

Hierarchy

  • LogsAggregateBucket

Index

Constructors

Properties

Constructors

constructor

Properties

Optional by

by?: {}
+

Hierarchy

  • LogsAggregateBucket

Index

Constructors

Properties

Constructors

constructor

Properties

Optional by

by?: {}

The key, value pairs for each group by

-

Type declaration

  • [key: string]: string

Optional computes

computes?: {}
+

Type declaration

  • [key: string]: string

Optional computes

computes?: {}

A map of the metric name -> value for regular compute or list of values for a timeseries

Type declaration

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateBucketValueTimeseriesPoint.html b/classes/v2.LogsAggregateBucketValueTimeseriesPoint.html index 29378d28d36..d6ec2753a82 100644 --- a/classes/v2.LogsAggregateBucketValueTimeseriesPoint.html +++ b/classes/v2.LogsAggregateBucketValueTimeseriesPoint.html @@ -1,7 +1,7 @@ LogsAggregateBucketValueTimeseriesPoint | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateBucketValueTimeseriesPoint

A timeseries point

-

Hierarchy

  • LogsAggregateBucketValueTimeseriesPoint

Index

Constructors

Properties

Constructors

constructor

Properties

Optional time

time?: string
+

Hierarchy

  • LogsAggregateBucketValueTimeseriesPoint

Index

Constructors

Properties

Constructors

constructor

Properties

Optional time

time?: string

The time value for this point

-

Optional value

value?: number
+

Optional value

value?: number

The value for this point

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateRequest.html b/classes/v2.LogsAggregateRequest.html index b196c251a73..a96f5373497 100644 --- a/classes/v2.LogsAggregateRequest.html +++ b/classes/v2.LogsAggregateRequest.html @@ -1,7 +1,7 @@ LogsAggregateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateRequest

The object sent with the request to retrieve a list of logs from your organization.

-

Hierarchy

  • LogsAggregateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional compute

compute?: LogsCompute[]
+

Hierarchy

  • LogsAggregateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional compute

compute?: LogsCompute[]

The list of metrics or timeseries to compute for the retrieved buckets.

-

Optional filter

filter?: LogsQueryFilter

Optional groupBy

groupBy?: LogsGroupBy[]
+

Optional filter

filter?: LogsQueryFilter

Optional groupBy

groupBy?: LogsGroupBy[]

The rules for the group by

-

Optional options

options?: LogsQueryOptions

Optional page

page?: LogsAggregateRequestPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional options

options?: LogsQueryOptions

Optional page

page?: LogsAggregateRequestPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateRequestPage.html b/classes/v2.LogsAggregateRequestPage.html index 003b7cbf629..e03e5aee67e 100644 --- a/classes/v2.LogsAggregateRequestPage.html +++ b/classes/v2.LogsAggregateRequestPage.html @@ -1,5 +1,5 @@ LogsAggregateRequestPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateRequestPage

Paging settings

-

Hierarchy

  • LogsAggregateRequestPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cursor

cursor?: string
+

Hierarchy

  • LogsAggregateRequestPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cursor

cursor?: string

The returned paging point to use to get the next results

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateResponse.html b/classes/v2.LogsAggregateResponse.html index aed93f28242..842ff9290cc 100644 --- a/classes/v2.LogsAggregateResponse.html +++ b/classes/v2.LogsAggregateResponse.html @@ -1,3 +1,3 @@ LogsAggregateResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateResponse

The response object for the logs aggregate API endpoint

-

Hierarchy

  • LogsAggregateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsAggregateResponseData

Optional meta

meta?: LogsResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsAggregateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsAggregateResponseData

Optional meta

meta?: LogsResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateResponseData.html b/classes/v2.LogsAggregateResponseData.html index 90c3676279b..e8a600e1955 100644 --- a/classes/v2.LogsAggregateResponseData.html +++ b/classes/v2.LogsAggregateResponseData.html @@ -1,5 +1,5 @@ LogsAggregateResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateResponseData

The query results

-

Hierarchy

  • LogsAggregateResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional buckets

buckets?: LogsAggregateBucket[]
+

Hierarchy

  • LogsAggregateResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional buckets

buckets?: LogsAggregateBucket[]

The list of matching buckets, one item per bucket

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsAggregateSort.html b/classes/v2.LogsAggregateSort.html index 3e7df4ae2fb..008e75879c8 100644 --- a/classes/v2.LogsAggregateSort.html +++ b/classes/v2.LogsAggregateSort.html @@ -1,5 +1,5 @@ LogsAggregateSort | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsAggregateSort

A sort rule

-

Hierarchy

  • LogsAggregateSort

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: LogsAggregationFunction

Optional metric

metric?: string
+

Hierarchy

  • LogsAggregateSort

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: LogsAggregationFunction

Optional metric

metric?: string

The metric to sort by (only used for type=measure)

-

Optional order

order?: LogsSortOrder

Optional type

type?: LogsAggregateSortType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional order

order?: LogsSortOrder

Optional type

type?: LogsAggregateSortType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsApi.html b/classes/v2.LogsApi.html index 4325c453e76..4f85d2fb96a 100644 --- a/classes/v2.LogsApi.html +++ b/classes/v2.LogsApi.html @@ -1,16 +1,16 @@ -LogsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsApi

Hierarchy

  • LogsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogsApi(configuration: v2.Configuration, requestFactory?: LogsApiRequestFactory, responseProcessor?: LogsApiResponseProcessor): v2.LogsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: LogsApiRequestFactory

Private responseProcessor

responseProcessor: LogsApiResponseProcessor

Methods

aggregateLogs

listLogs

listLogsGet

Returns Promise<v2.LogsListResponse>

listLogsGet

submitLog

Returns Promise<v2.LogsListResponse>

submitLog

  • Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - Maximum size for a single log: 1MB - Maximum array size if sending multiple logs in an array: 1000 entries Any log exceeding 1MB is accepted and truncated by Datadog: - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. Datadog recommends sending your logs compressed. Add the Content-Encoding: gzip header to the request when sending compressed logs. The status codes answered by the HTTP API are: - 202: Accepted: the request has been accepted for processing - 400: Bad request (likely an issue in the payload formatting) - 401: Unauthorized (likely a missing API Key) - 403: Permission issue (likely using an invalid API Key) - 408: Request Timeout, request should be retried after some time - 413: Payload too large (batch is above 5MB uncompressed) - 429: Too Many Requests, request should be retried after some time - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time

    Parameters

Hierarchy

  • LogsArchive

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveAttributes.html b/classes/v2.LogsArchiveAttributes.html index cf4ea43d2cf..b9a6baad136 100644 --- a/classes/v2.LogsArchiveAttributes.html +++ b/classes/v2.LogsArchiveAttributes.html @@ -1,11 +1,11 @@ LogsArchiveAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveAttributes

The attributes associated with the archive.

-

Hierarchy

  • LogsArchiveAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

destination

destination: null | LogsArchiveDestination

Optional includeTags

includeTags?: boolean
+

Hierarchy

  • LogsArchiveAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

destination

destination: null | LogsArchiveDestination

Optional includeTags

includeTags?: boolean

To store the tags in the archive, set the value "true". If it is set to "false", the tags will be deleted when the logs are sent to the archive.

-

name

name: string
+

name

name: string

The archive name.

-

query

query: string
+

query

query: string

The archive query/filter. Logs matching this query are included in the archive.

-

Optional rehydrationTags

rehydrationTags?: string[]
+

Optional rehydrationTags

rehydrationTags?: string[]

An array of tags to add to rehydrated logs from an archive.

-

Optional state

state?: LogsArchiveState

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional state

state?: LogsArchiveState

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveCreateRequest.html b/classes/v2.LogsArchiveCreateRequest.html index 0f5dae6c9cb..075ccf9911b 100644 --- a/classes/v2.LogsArchiveCreateRequest.html +++ b/classes/v2.LogsArchiveCreateRequest.html @@ -1,3 +1,3 @@ LogsArchiveCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveCreateRequest

The logs archive.

-

Hierarchy

  • LogsArchiveCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveCreateRequestDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsArchiveCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveCreateRequestDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveCreateRequestAttributes.html b/classes/v2.LogsArchiveCreateRequestAttributes.html index caff314c295..9820de634a4 100644 --- a/classes/v2.LogsArchiveCreateRequestAttributes.html +++ b/classes/v2.LogsArchiveCreateRequestAttributes.html @@ -1,11 +1,11 @@ LogsArchiveCreateRequestAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveCreateRequestAttributes

The attributes associated with the archive.

-

Hierarchy

  • LogsArchiveCreateRequestAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

destination

destination: LogsArchiveCreateRequestDestination

Optional includeTags

includeTags?: boolean
+

Hierarchy

  • LogsArchiveCreateRequestAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

destination

destination: LogsArchiveCreateRequestDestination

Optional includeTags

includeTags?: boolean

To store the tags in the archive, set the value "true". If it is set to "false", the tags will be deleted when the logs are sent to the archive.

-

name

name: string
+

name

name: string

The archive name.

-

query

query: string
+

query

query: string

The archive query/filter. Logs matching this query are included in the archive.

-

Optional rehydrationTags

rehydrationTags?: string[]
+

Optional rehydrationTags

rehydrationTags?: string[]

An array of tags to add to rehydrated logs from an archive.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveCreateRequestDefinition.html b/classes/v2.LogsArchiveCreateRequestDefinition.html index bc4461af18d..cd3dff54f1f 100644 --- a/classes/v2.LogsArchiveCreateRequestDefinition.html +++ b/classes/v2.LogsArchiveCreateRequestDefinition.html @@ -1,5 +1,5 @@ LogsArchiveCreateRequestDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveCreateRequestDefinition

The definition of an archive.

-

Hierarchy

  • LogsArchiveCreateRequestDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: LogsArchiveCreateRequestAttributes

type

type: string
+

Hierarchy

  • LogsArchiveCreateRequestDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: LogsArchiveCreateRequestAttributes

type

type: string

The type of the resource. The value should always be archives.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveDefinition.html b/classes/v2.LogsArchiveDefinition.html index 02cc5319c10..5cb66395981 100644 --- a/classes/v2.LogsArchiveDefinition.html +++ b/classes/v2.LogsArchiveDefinition.html @@ -1,7 +1,7 @@ LogsArchiveDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveDefinition

The definition of an archive.

-

Hierarchy

  • LogsArchiveDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: LogsArchiveAttributes

Optional id

id?: string
+

Hierarchy

  • LogsArchiveDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: LogsArchiveAttributes

Optional id

id?: string

The archive ID.

-

type

type: string
+

type

type: string

The type of the resource. The value should always be archives.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveDestinationAzure.html b/classes/v2.LogsArchiveDestinationAzure.html index 200289a0a7a..ef775b14555 100644 --- a/classes/v2.LogsArchiveDestinationAzure.html +++ b/classes/v2.LogsArchiveDestinationAzure.html @@ -1,11 +1,11 @@ LogsArchiveDestinationAzure | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveDestinationAzure

The Azure archive destination.

-

Hierarchy

  • LogsArchiveDestinationAzure

Index

Constructors

Properties

Constructors

constructor

Properties

container

container: string
+

Hierarchy

  • LogsArchiveDestinationAzure

Index

Constructors

Properties

Constructors

constructor

Properties

container

container: string

The container where the archive will be stored.

-

integration

integration: LogsArchiveIntegrationAzure

Optional path

path?: string
+

integration

integration: LogsArchiveIntegrationAzure

Optional path

path?: string

The archive path.

-

Optional region

region?: string
+

Optional region

region?: string

The region where the archive will be stored.

-

storageAccount

storageAccount: string
+

storageAccount

storageAccount: string

The associated storage account.

-

type

type: "azure"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "azure"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveDestinationGCS.html b/classes/v2.LogsArchiveDestinationGCS.html index ac1330a4bc5..5a75095b444 100644 --- a/classes/v2.LogsArchiveDestinationGCS.html +++ b/classes/v2.LogsArchiveDestinationGCS.html @@ -1,7 +1,7 @@ LogsArchiveDestinationGCS | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveDestinationGCS

The GCS archive destination.

-

Hierarchy

  • LogsArchiveDestinationGCS

Index

Constructors

Properties

Constructors

constructor

Properties

bucket

bucket: string
+

Hierarchy

  • LogsArchiveDestinationGCS

Index

Constructors

Properties

Constructors

constructor

Properties

bucket

bucket: string

The bucket where the archive will be stored.

-

integration

integration: LogsArchiveIntegrationGCS

Optional path

path?: string
+

integration

integration: LogsArchiveIntegrationGCS

Optional path

path?: string

The archive path.

-

type

type: "gcs"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "gcs"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveDestinationS3.html b/classes/v2.LogsArchiveDestinationS3.html index 295c00957f3..15560658b4d 100644 --- a/classes/v2.LogsArchiveDestinationS3.html +++ b/classes/v2.LogsArchiveDestinationS3.html @@ -1,7 +1,7 @@ LogsArchiveDestinationS3 | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveDestinationS3

The S3 archive destination.

-

Hierarchy

  • LogsArchiveDestinationS3

Index

Constructors

Properties

Constructors

constructor

Properties

bucket

bucket: string
+

Hierarchy

  • LogsArchiveDestinationS3

Index

Constructors

Properties

Constructors

constructor

Properties

bucket

bucket: string

The bucket where the archive will be stored.

-

integration

integration: LogsArchiveIntegrationS3

Optional path

path?: string
+

integration

integration: LogsArchiveIntegrationS3

Optional path

path?: string

The archive path.

-

type

type: "s3"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "s3"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveIntegrationAzure.html b/classes/v2.LogsArchiveIntegrationAzure.html index 99291a3e746..95a5363fc2d 100644 --- a/classes/v2.LogsArchiveIntegrationAzure.html +++ b/classes/v2.LogsArchiveIntegrationAzure.html @@ -1,7 +1,7 @@ LogsArchiveIntegrationAzure | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveIntegrationAzure

The Azure archive's integration destination.

-

Hierarchy

  • LogsArchiveIntegrationAzure

Index

Constructors

Properties

Constructors

constructor

Properties

clientId

clientId: string
+

Hierarchy

  • LogsArchiveIntegrationAzure

Index

Constructors

Properties

Constructors

constructor

Properties

clientId

clientId: string

A client ID.

-

tenantId

tenantId: string
+

tenantId

tenantId: string

A tenant ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveIntegrationGCS.html b/classes/v2.LogsArchiveIntegrationGCS.html index af9825f6707..785db82bee6 100644 --- a/classes/v2.LogsArchiveIntegrationGCS.html +++ b/classes/v2.LogsArchiveIntegrationGCS.html @@ -1,7 +1,7 @@ LogsArchiveIntegrationGCS | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveIntegrationGCS

The GCS archive's integration destination.

-

Hierarchy

  • LogsArchiveIntegrationGCS

Index

Constructors

Properties

Constructors

constructor

Properties

clientEmail

clientEmail: string
+

Hierarchy

  • LogsArchiveIntegrationGCS

Index

Constructors

Properties

Constructors

constructor

Properties

clientEmail

clientEmail: string

A client email.

-

projectId

projectId: string
+

projectId

projectId: string

A project ID.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveIntegrationS3.html b/classes/v2.LogsArchiveIntegrationS3.html index 15a85e14f29..8c57d903021 100644 --- a/classes/v2.LogsArchiveIntegrationS3.html +++ b/classes/v2.LogsArchiveIntegrationS3.html @@ -1,7 +1,7 @@ LogsArchiveIntegrationS3 | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveIntegrationS3

The S3 Archive's integration destination.

-

Hierarchy

  • LogsArchiveIntegrationS3

Index

Constructors

Properties

Constructors

constructor

Properties

accountId

accountId: string
+

Hierarchy

  • LogsArchiveIntegrationS3

Index

Constructors

Properties

Constructors

constructor

Properties

accountId

accountId: string

The account ID for the integration.

-

roleName

roleName: string
+

roleName

roleName: string

The path of the integration.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveOrder.html b/classes/v2.LogsArchiveOrder.html index 8553217a36f..0e57416f85e 100644 --- a/classes/v2.LogsArchiveOrder.html +++ b/classes/v2.LogsArchiveOrder.html @@ -1,3 +1,3 @@ LogsArchiveOrder | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveOrder

A ordered list of archive IDs.

-

Hierarchy

  • LogsArchiveOrder

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveOrderDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsArchiveOrder

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveOrderDefinition

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveOrderAttributes.html b/classes/v2.LogsArchiveOrderAttributes.html index ff99ac3b084..605270ab5d7 100644 --- a/classes/v2.LogsArchiveOrderAttributes.html +++ b/classes/v2.LogsArchiveOrderAttributes.html @@ -1,5 +1,5 @@ LogsArchiveOrderAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveOrderAttributes

The attributes associated with the archive order.

-

Hierarchy

  • LogsArchiveOrderAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

archiveIds

archiveIds: string[]
+

Hierarchy

  • LogsArchiveOrderAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

archiveIds

archiveIds: string[]

An ordered array of <ARCHIVE_ID> strings, the order of archive IDs in the array define the overall archives order for Datadog.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchiveOrderDefinition.html b/classes/v2.LogsArchiveOrderDefinition.html index 8fd0aba0b1f..9f1cb1d0662 100644 --- a/classes/v2.LogsArchiveOrderDefinition.html +++ b/classes/v2.LogsArchiveOrderDefinition.html @@ -1,3 +1,3 @@ LogsArchiveOrderDefinition | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchiveOrderDefinition

The definition of an archive order.

-

Hierarchy

  • LogsArchiveOrderDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: LogsArchiveOrderAttributes

type

type: "archive_order"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsArchiveOrderDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: LogsArchiveOrderAttributes

type

type: "archive_order"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchives.html b/classes/v2.LogsArchives.html index 151bae49146..352be06dd16 100644 --- a/classes/v2.LogsArchives.html +++ b/classes/v2.LogsArchives.html @@ -1,5 +1,5 @@ LogsArchives | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchives

The available archives.

-

Hierarchy

  • LogsArchives

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveDefinition[]
+

Hierarchy

  • LogsArchives

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsArchiveDefinition[]

A list of archives.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsArchivesApi.html b/classes/v2.LogsArchivesApi.html index b60e6531054..1ef689b5a62 100644 --- a/classes/v2.LogsArchivesApi.html +++ b/classes/v2.LogsArchivesApi.html @@ -1,36 +1,36 @@ -LogsArchivesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsArchivesApi

Hierarchy

  • LogsArchivesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogsArchivesApi(configuration: v2.Configuration, requestFactory?: LogsArchivesApiRequestFactory, responseProcessor?: LogsArchivesApiResponseProcessor): LogsArchivesApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: LogsArchivesApiRequestFactory

Private responseProcessor

responseProcessor: LogsArchivesApiResponseProcessor

Methods

addReadRoleToArchive

createLogsArchive

deleteLogsArchive

Returns Promise<LogsArchive>

deleteLogsArchive

getLogsArchive

Returns Promise<void>

getLogsArchive

getLogsArchiveOrder

Returns Promise<LogsArchive>

getLogsArchiveOrder

listArchiveReadRoles

listArchiveReadRoles

listLogsArchives

Returns Promise<RolesResponse>

listLogsArchives

removeRoleFromArchive

removeRoleFromArchive

updateLogsArchive

Returns Promise<void>

updateLogsArchive

updateLogsArchiveOrder

Returns Promise<LogsArchive>

updateLogsArchiveOrder

Optional type

type?: LogsComputeType

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsGroupBy.html b/classes/v2.LogsGroupBy.html index 98ca9e69764..dcc8f55744d 100644 --- a/classes/v2.LogsGroupBy.html +++ b/classes/v2.LogsGroupBy.html @@ -1,7 +1,7 @@ LogsGroupBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsGroupBy

A group by rule

-

Hierarchy

  • LogsGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string
+

Hierarchy

  • LogsGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

facet

facet: string

The name of the facet to use (required)

-

Optional histogram

histogram?: LogsGroupByHistogram

Optional limit

limit?: number
+

Optional histogram

histogram?: LogsGroupByHistogram

Optional limit

limit?: number

The maximum buckets to return for this group by

-

Optional missing

missing?: LogsGroupByMissing

Optional sort

sort?: LogsAggregateSort

Optional total

total?: LogsGroupByTotal

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional missing

missing?: LogsGroupByMissing

Optional sort

sort?: LogsAggregateSort

Optional total

total?: LogsGroupByTotal

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsGroupByHistogram.html b/classes/v2.LogsGroupByHistogram.html index eedb9bb8888..41b8911f30a 100644 --- a/classes/v2.LogsGroupByHistogram.html +++ b/classes/v2.LogsGroupByHistogram.html @@ -1,9 +1,9 @@ LogsGroupByHistogram | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsGroupByHistogram

Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.

-

Hierarchy

  • LogsGroupByHistogram

Index

Constructors

Properties

Constructors

constructor

Properties

interval

interval: number
+

Hierarchy

  • LogsGroupByHistogram

Index

Constructors

Properties

Constructors

constructor

Properties

interval

interval: number

The bin size of the histogram buckets

-

max

max: number
+

max

max: number

The maximum value for the measure used in the histogram (values greater than this one are filtered out)

-

min

min: number
+

min

min: number

The minimum value for the measure used in the histogram (values smaller than this one are filtered out)

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsListRequest.html b/classes/v2.LogsListRequest.html index 1a5d47efbc3..acba987b2b2 100644 --- a/classes/v2.LogsListRequest.html +++ b/classes/v2.LogsListRequest.html @@ -1,3 +1,3 @@ LogsListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsListRequest

The request for a logs list.

-

Hierarchy

  • LogsListRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsQueryFilter

Optional options

options?: LogsQueryOptions

Optional page

page?: LogsListRequestPage

Optional sort

sort?: v2.LogsSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsListRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsQueryFilter

Optional options

options?: LogsQueryOptions

Optional page

page?: LogsListRequestPage

Optional sort

sort?: v2.LogsSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsListRequestPage.html b/classes/v2.LogsListRequestPage.html index d1c1894a642..fd9d3234d87 100644 --- a/classes/v2.LogsListRequestPage.html +++ b/classes/v2.LogsListRequestPage.html @@ -1,7 +1,7 @@ LogsListRequestPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsListRequestPage

Paging attributes for listing logs.

-

Hierarchy

  • LogsListRequestPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cursor

cursor?: string
+

Hierarchy

  • LogsListRequestPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cursor

cursor?: string

List following results with a cursor provided in the previous query.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Maximum number of logs in the response.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsListResponse.html b/classes/v2.LogsListResponse.html index a88bc05fede..d17ea1f06b4 100644 --- a/classes/v2.LogsListResponse.html +++ b/classes/v2.LogsListResponse.html @@ -1,5 +1,5 @@ LogsListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsListResponse

Response object with all logs matching the request and pagination information.

-

Hierarchy

  • LogsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: v2.Log[]
+

Hierarchy

  • LogsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: v2.Log[]

Array of logs matching the request.

-

Optional links

links?: LogsListResponseLinks

Optional meta

meta?: LogsResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional links

links?: LogsListResponseLinks

Optional meta

meta?: LogsResponseMetadata

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsListResponseLinks.html b/classes/v2.LogsListResponseLinks.html index ea8a4292d0c..6ee3b13d063 100644 --- a/classes/v2.LogsListResponseLinks.html +++ b/classes/v2.LogsListResponseLinks.html @@ -1,5 +1,5 @@ LogsListResponseLinks | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsListResponseLinks

Links attributes.

-

Hierarchy

  • LogsListResponseLinks

Index

Constructors

Properties

Constructors

constructor

Properties

Optional next

next?: string
+

Hierarchy

  • LogsListResponseLinks

Index

Constructors

Properties

Constructors

constructor

Properties

Optional next

next?: string

Link for the next set of results. Note that the request can also be made using the POST endpoint.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricCompute.html b/classes/v2.LogsMetricCompute.html index f908caf0081..e42c940c18a 100644 --- a/classes/v2.LogsMetricCompute.html +++ b/classes/v2.LogsMetricCompute.html @@ -1,5 +1,5 @@ LogsMetricCompute | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricCompute

The compute rule to compute the log-based metric.

-

Hierarchy

  • LogsMetricCompute

Index

Constructors

Properties

Constructors

constructor

Properties

aggregationType

aggregationType: LogsMetricComputeAggregationType

Optional path

path?: string
+

Hierarchy

  • LogsMetricCompute

Index

Constructors

Properties

Constructors

constructor

Properties

aggregationType

aggregationType: LogsMetricComputeAggregationType

Optional path

path?: string

The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution").

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricCreateAttributes.html b/classes/v2.LogsMetricCreateAttributes.html index 8293ba21424..43ff9292a39 100644 --- a/classes/v2.LogsMetricCreateAttributes.html +++ b/classes/v2.LogsMetricCreateAttributes.html @@ -1,5 +1,5 @@ LogsMetricCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricCreateAttributes

The object describing the Datadog log-based metric to create.

-

Hierarchy

  • LogsMetricCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

compute

compute: LogsMetricCompute

Optional filter

filter?: LogsMetricFilter

Optional groupBy

groupBy?: LogsMetricGroupBy[]
+

Hierarchy

  • LogsMetricCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

compute

compute: LogsMetricCompute

Optional filter

filter?: LogsMetricFilter

Optional groupBy

groupBy?: LogsMetricGroupBy[]

The rules for the group by.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricCreateData.html b/classes/v2.LogsMetricCreateData.html index 7ac14818f1a..acb9a9709ed 100644 --- a/classes/v2.LogsMetricCreateData.html +++ b/classes/v2.LogsMetricCreateData.html @@ -1,5 +1,5 @@ LogsMetricCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricCreateData

The new log-based metric properties.

-

Hierarchy

  • LogsMetricCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: LogsMetricCreateAttributes

id

id: string
+

Hierarchy

  • LogsMetricCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: LogsMetricCreateAttributes

id

id: string

The name of the log-based metric.

-

type

type: "logs_metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "logs_metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricCreateRequest.html b/classes/v2.LogsMetricCreateRequest.html index 342d6d5f9fa..e47405230b4 100644 --- a/classes/v2.LogsMetricCreateRequest.html +++ b/classes/v2.LogsMetricCreateRequest.html @@ -1,3 +1,3 @@ LogsMetricCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricCreateRequest

The new log-based metric body.

-

Hierarchy

  • LogsMetricCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: LogsMetricCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsMetricCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: LogsMetricCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricFilter.html b/classes/v2.LogsMetricFilter.html index 8d6477d5995..4c4798b2e99 100644 --- a/classes/v2.LogsMetricFilter.html +++ b/classes/v2.LogsMetricFilter.html @@ -1,5 +1,5 @@ LogsMetricFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricFilter

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

-

Hierarchy

  • LogsMetricFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string
+

Hierarchy

  • LogsMetricFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string

The search query - following the log search syntax.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricGroupBy.html b/classes/v2.LogsMetricGroupBy.html index 8044b67701e..a5387cff581 100644 --- a/classes/v2.LogsMetricGroupBy.html +++ b/classes/v2.LogsMetricGroupBy.html @@ -1,7 +1,7 @@ LogsMetricGroupBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricGroupBy

A group by rule.

-

Hierarchy

  • LogsMetricGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

path

path: string
+

Hierarchy

  • LogsMetricGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

path

path: string

The path to the value the log-based metric will be aggregated over.

-

Optional tagName

tagName?: string
+

Optional tagName

tagName?: string

Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricResponse.html b/classes/v2.LogsMetricResponse.html index 3f564790e53..19eee4f0a5b 100644 --- a/classes/v2.LogsMetricResponse.html +++ b/classes/v2.LogsMetricResponse.html @@ -1,3 +1,3 @@ LogsMetricResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricResponse

The log-based metric object.

-

Hierarchy

  • LogsMetricResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsMetricResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsMetricResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: LogsMetricResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricResponseAttributes.html b/classes/v2.LogsMetricResponseAttributes.html index f160b81dd92..084fc5dbef1 100644 --- a/classes/v2.LogsMetricResponseAttributes.html +++ b/classes/v2.LogsMetricResponseAttributes.html @@ -1,5 +1,5 @@ LogsMetricResponseAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricResponseAttributes

The object describing a Datadog log-based metric.

-

Hierarchy

  • LogsMetricResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional compute

compute?: LogsMetricResponseCompute

Optional filter

filter?: LogsMetricResponseFilter

Optional groupBy

groupBy?: LogsMetricResponseGroupBy[]
+

Hierarchy

  • LogsMetricResponseAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional compute

compute?: LogsMetricResponseCompute

Optional filter

filter?: LogsMetricResponseFilter

Optional groupBy

groupBy?: LogsMetricResponseGroupBy[]

The rules for the group by.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricResponseCompute.html b/classes/v2.LogsMetricResponseCompute.html index 11e32502214..f11135183ba 100644 --- a/classes/v2.LogsMetricResponseCompute.html +++ b/classes/v2.LogsMetricResponseCompute.html @@ -1,5 +1,5 @@ LogsMetricResponseCompute | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricResponseCompute

The compute rule to compute the log-based metric.

-

Hierarchy

  • LogsMetricResponseCompute

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregationType

aggregationType?: LogsMetricResponseComputeAggregationType

Optional path

path?: string
+

Hierarchy

  • LogsMetricResponseCompute

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregationType

aggregationType?: LogsMetricResponseComputeAggregationType

Optional path

path?: string

The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution").

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricResponseData.html b/classes/v2.LogsMetricResponseData.html index 600aa09f4c6..1e0ee65d203 100644 --- a/classes/v2.LogsMetricResponseData.html +++ b/classes/v2.LogsMetricResponseData.html @@ -1,5 +1,5 @@ LogsMetricResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricResponseData

The log-based metric properties.

-

Hierarchy

  • LogsMetricResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: LogsMetricResponseAttributes

Optional id

id?: string
+

Hierarchy

  • LogsMetricResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: LogsMetricResponseAttributes

Optional id

id?: string

The name of the log-based metric.

-

Optional type

type?: "logs_metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "logs_metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricResponseFilter.html b/classes/v2.LogsMetricResponseFilter.html index 3e7f7eff672..343aa110499 100644 --- a/classes/v2.LogsMetricResponseFilter.html +++ b/classes/v2.LogsMetricResponseFilter.html @@ -1,5 +1,5 @@ LogsMetricResponseFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricResponseFilter

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

-

Hierarchy

  • LogsMetricResponseFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string
+

Hierarchy

  • LogsMetricResponseFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional query

query?: string

The search query - following the log search syntax.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricResponseGroupBy.html b/classes/v2.LogsMetricResponseGroupBy.html index f701b0b5334..61eaaea1697 100644 --- a/classes/v2.LogsMetricResponseGroupBy.html +++ b/classes/v2.LogsMetricResponseGroupBy.html @@ -1,7 +1,7 @@ LogsMetricResponseGroupBy | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricResponseGroupBy

A group by rule.

-

Hierarchy

  • LogsMetricResponseGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional path

path?: string
+

Hierarchy

  • LogsMetricResponseGroupBy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional path

path?: string

The path to the value the log-based metric will be aggregated over.

-

Optional tagName

tagName?: string
+

Optional tagName

tagName?: string

Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricUpdateAttributes.html b/classes/v2.LogsMetricUpdateAttributes.html index 2b028e62e88..ca0c9108aa1 100644 --- a/classes/v2.LogsMetricUpdateAttributes.html +++ b/classes/v2.LogsMetricUpdateAttributes.html @@ -1,5 +1,5 @@ LogsMetricUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricUpdateAttributes

The log-based metric properties that will be updated.

-

Hierarchy

  • LogsMetricUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsMetricFilter

Optional groupBy

groupBy?: LogsMetricGroupBy[]
+

Hierarchy

  • LogsMetricUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: LogsMetricFilter

Optional groupBy

groupBy?: LogsMetricGroupBy[]

The rules for the group by.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricUpdateData.html b/classes/v2.LogsMetricUpdateData.html index 7999d010a48..7b6eac1ed7c 100644 --- a/classes/v2.LogsMetricUpdateData.html +++ b/classes/v2.LogsMetricUpdateData.html @@ -1,3 +1,3 @@ LogsMetricUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricUpdateData

The new log-based metric properties.

-

Hierarchy

  • LogsMetricUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: LogsMetricUpdateAttributes

type

type: "logs_metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsMetricUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: LogsMetricUpdateAttributes

type

type: "logs_metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricUpdateRequest.html b/classes/v2.LogsMetricUpdateRequest.html index e5ed0fdd556..c2833e21178 100644 --- a/classes/v2.LogsMetricUpdateRequest.html +++ b/classes/v2.LogsMetricUpdateRequest.html @@ -1,3 +1,3 @@ LogsMetricUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricUpdateRequest

The new log-based metric body.

-

Hierarchy

  • LogsMetricUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: LogsMetricUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • LogsMetricUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: LogsMetricUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.LogsMetricsApi.html b/classes/v2.LogsMetricsApi.html index 22fb557b619..2a75536cb25 100644 --- a/classes/v2.LogsMetricsApi.html +++ b/classes/v2.LogsMetricsApi.html @@ -1,18 +1,18 @@ -LogsMetricsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogsMetricsApi

Hierarchy

  • LogsMetricsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogsMetricsApi(configuration: v2.Configuration, requestFactory?: LogsMetricsApiRequestFactory, responseProcessor?: LogsMetricsApiResponseProcessor): LogsMetricsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: LogsMetricsApiRequestFactory

Private responseProcessor

responseProcessor: LogsMetricsApiResponseProcessor

Methods

createLogsMetric

deleteLogsMetric

getLogsMetric

Returns Promise<void>

getLogsMetric

listLogsMetrics

Returns Promise<LogsMetricResponse>

listLogsMetrics

updateLogsMetric

updateLogsMetric

Optional type

type?: "metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricAllTags.html b/classes/v2.MetricAllTags.html index 1805ea4c7e0..1a9c71f2210 100644 --- a/classes/v2.MetricAllTags.html +++ b/classes/v2.MetricAllTags.html @@ -1,5 +1,5 @@ MetricAllTags | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricAllTags

Object for a single metric's indexed tags.

-

Hierarchy

  • MetricAllTags

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricAllTagsAttributes

Optional id

id?: string
+

Hierarchy

  • MetricAllTags

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricAllTagsAttributes

Optional id

id?: string

The metric name for this resource.

-

Optional type

type?: "metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "metrics"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricAllTagsAttributes.html b/classes/v2.MetricAllTagsAttributes.html index 2e46fdcead2..a408ae63a59 100644 --- a/classes/v2.MetricAllTagsAttributes.html +++ b/classes/v2.MetricAllTagsAttributes.html @@ -1,5 +1,5 @@ MetricAllTagsAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricAllTagsAttributes

Object containing the definition of a metric's tags.

-

Hierarchy

  • MetricAllTagsAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tags

tags?: string[]
+

Hierarchy

  • MetricAllTagsAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional tags

tags?: string[]

List of indexed tag value pairs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricAllTagsResponse.html b/classes/v2.MetricAllTagsResponse.html index f823b9efc9d..7cd909c252a 100644 --- a/classes/v2.MetricAllTagsResponse.html +++ b/classes/v2.MetricAllTagsResponse.html @@ -1,3 +1,3 @@ MetricAllTagsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricAllTagsResponse

Response object that includes a single metric's indexed tags.

-

Hierarchy

  • MetricAllTagsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricAllTags

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricAllTagsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricAllTags

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigCreate.html b/classes/v2.MetricBulkTagConfigCreate.html index 7519146ecab..157aaf2d3a2 100644 --- a/classes/v2.MetricBulkTagConfigCreate.html +++ b/classes/v2.MetricBulkTagConfigCreate.html @@ -1,5 +1,5 @@ MetricBulkTagConfigCreate | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigCreate

Request object to bulk configure tags for metrics matching the given prefix.

-

Hierarchy

  • MetricBulkTagConfigCreate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricBulkTagConfigCreateAttributes

id

id: string
+

Hierarchy

  • MetricBulkTagConfigCreate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricBulkTagConfigCreateAttributes

id

id: string

A text prefix to match against metric names.

-

type

type: "metric_bulk_configure_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "metric_bulk_configure_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigCreateAttributes.html b/classes/v2.MetricBulkTagConfigCreateAttributes.html index 202376a0b42..3167e15be1e 100644 --- a/classes/v2.MetricBulkTagConfigCreateAttributes.html +++ b/classes/v2.MetricBulkTagConfigCreateAttributes.html @@ -1,7 +1,7 @@ MetricBulkTagConfigCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigCreateAttributes

Optional parameters for bulk creating metric tag configurations.

-

Hierarchy

  • MetricBulkTagConfigCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional emails

emails?: string[]
+

Hierarchy

  • MetricBulkTagConfigCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional emails

emails?: string[]

A list of account emails to notify when the configuration is applied.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

A list of tag names to apply to the configuration.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigCreateRequest.html b/classes/v2.MetricBulkTagConfigCreateRequest.html index 92db9209ad6..01ae3adf7ce 100644 --- a/classes/v2.MetricBulkTagConfigCreateRequest.html +++ b/classes/v2.MetricBulkTagConfigCreateRequest.html @@ -1,3 +1,3 @@ MetricBulkTagConfigCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigCreateRequest

Wrapper object for a single bulk tag configuration request.

-

Hierarchy

  • MetricBulkTagConfigCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricBulkTagConfigCreate

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricBulkTagConfigCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricBulkTagConfigCreate

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigDelete.html b/classes/v2.MetricBulkTagConfigDelete.html index d17c4288f9c..d0db1c31ce5 100644 --- a/classes/v2.MetricBulkTagConfigDelete.html +++ b/classes/v2.MetricBulkTagConfigDelete.html @@ -1,5 +1,5 @@ MetricBulkTagConfigDelete | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigDelete

Request object to bulk delete all tag configurations for metrics matching the given prefix.

-

Hierarchy

  • MetricBulkTagConfigDelete

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricBulkTagConfigDeleteAttributes

id

id: string
+

Hierarchy

  • MetricBulkTagConfigDelete

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricBulkTagConfigDeleteAttributes

id

id: string

A text prefix to match against metric names.

-

type

type: "metric_bulk_configure_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "metric_bulk_configure_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigDeleteAttributes.html b/classes/v2.MetricBulkTagConfigDeleteAttributes.html index 0ae31410042..141122ca836 100644 --- a/classes/v2.MetricBulkTagConfigDeleteAttributes.html +++ b/classes/v2.MetricBulkTagConfigDeleteAttributes.html @@ -1,5 +1,5 @@ MetricBulkTagConfigDeleteAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigDeleteAttributes

Optional parameters for bulk deleting metric tag configurations.

-

Hierarchy

  • MetricBulkTagConfigDeleteAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional emails

emails?: string[]
+

Hierarchy

  • MetricBulkTagConfigDeleteAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional emails

emails?: string[]

A list of account emails to notify when the configuration is applied.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigDeleteRequest.html b/classes/v2.MetricBulkTagConfigDeleteRequest.html index c55589d026c..78731535658 100644 --- a/classes/v2.MetricBulkTagConfigDeleteRequest.html +++ b/classes/v2.MetricBulkTagConfigDeleteRequest.html @@ -1,3 +1,3 @@ MetricBulkTagConfigDeleteRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigDeleteRequest

Wrapper object for a single bulk tag deletion request.

-

Hierarchy

  • MetricBulkTagConfigDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricBulkTagConfigDelete

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricBulkTagConfigDeleteRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricBulkTagConfigDelete

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigResponse.html b/classes/v2.MetricBulkTagConfigResponse.html index d27ff83bbe9..0feb0850024 100644 --- a/classes/v2.MetricBulkTagConfigResponse.html +++ b/classes/v2.MetricBulkTagConfigResponse.html @@ -1,3 +1,3 @@ MetricBulkTagConfigResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigResponse

Wrapper for a single bulk tag configuration status response.

-

Hierarchy

  • MetricBulkTagConfigResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricBulkTagConfigStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricBulkTagConfigResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricBulkTagConfigStatus

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigStatus.html b/classes/v2.MetricBulkTagConfigStatus.html index ac8108b2cf3..0e7f4771b44 100644 --- a/classes/v2.MetricBulkTagConfigStatus.html +++ b/classes/v2.MetricBulkTagConfigStatus.html @@ -1,5 +1,5 @@ MetricBulkTagConfigStatus | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigStatus

The status of a request to bulk configure metric tags. It contains the fields from the original request for reference.

-

Hierarchy

  • MetricBulkTagConfigStatus

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricBulkTagConfigStatusAttributes

id

id: string
+

Hierarchy

  • MetricBulkTagConfigStatus

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricBulkTagConfigStatusAttributes

id

id: string

A text prefix to match against metric names.

-

type

type: "metric_bulk_configure_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "metric_bulk_configure_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricBulkTagConfigStatusAttributes.html b/classes/v2.MetricBulkTagConfigStatusAttributes.html index 323532bc561..9a1b01b24bc 100644 --- a/classes/v2.MetricBulkTagConfigStatusAttributes.html +++ b/classes/v2.MetricBulkTagConfigStatusAttributes.html @@ -1,9 +1,9 @@ MetricBulkTagConfigStatusAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricBulkTagConfigStatusAttributes

Optional attributes for the status of a bulk tag configuration request.

-

Hierarchy

  • MetricBulkTagConfigStatusAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional emails

emails?: string[]
+

Hierarchy

  • MetricBulkTagConfigStatusAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional emails

emails?: string[]

A list of account emails to notify when the configuration is applied.

-

Optional status

status?: string
+

Optional status

status?: string

The status of the request.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

A list of tag names to apply to the configuration.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricCustomAggregation.html b/classes/v2.MetricCustomAggregation.html index 70d6dfd3c18..c4d99b4e860 100644 --- a/classes/v2.MetricCustomAggregation.html +++ b/classes/v2.MetricCustomAggregation.html @@ -1,3 +1,3 @@ MetricCustomAggregation | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricCustomAggregation

A time and space aggregation combination for use in query.

-

Hierarchy

  • MetricCustomAggregation

Index

Constructors

Properties

Constructors

constructor

Properties

space

space: MetricCustomSpaceAggregation

time

time: MetricCustomTimeAggregation

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricCustomAggregation

Index

Constructors

Properties

Constructors

constructor

Properties

space

space: MetricCustomSpaceAggregation

time

time: MetricCustomTimeAggregation

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricDistinctVolume.html b/classes/v2.MetricDistinctVolume.html index fa6797c27ae..d1e7619c9b6 100644 --- a/classes/v2.MetricDistinctVolume.html +++ b/classes/v2.MetricDistinctVolume.html @@ -1,5 +1,5 @@ MetricDistinctVolume | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricDistinctVolume

Object for a single metric's distinct volume.

-

Hierarchy

  • MetricDistinctVolume

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricDistinctVolumeAttributes

Optional id

id?: string
+

Hierarchy

  • MetricDistinctVolume

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricDistinctVolumeAttributes

Optional id

id?: string

The metric name for this resource.

-

Optional type

type?: "distinct_metric_volumes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "distinct_metric_volumes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricDistinctVolumeAttributes.html b/classes/v2.MetricDistinctVolumeAttributes.html index 71dcd15d1f8..113d0a64e81 100644 --- a/classes/v2.MetricDistinctVolumeAttributes.html +++ b/classes/v2.MetricDistinctVolumeAttributes.html @@ -1,5 +1,5 @@ MetricDistinctVolumeAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricDistinctVolumeAttributes

Object containing the definition of a metric's distinct volume.

-

Hierarchy

  • MetricDistinctVolumeAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional distinctVolume

distinctVolume?: number
+

Hierarchy

  • MetricDistinctVolumeAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional distinctVolume

distinctVolume?: number

Distinct volume for the given metric.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricIngestedIndexedVolume.html b/classes/v2.MetricIngestedIndexedVolume.html index b0739ddc821..8c4e2219387 100644 --- a/classes/v2.MetricIngestedIndexedVolume.html +++ b/classes/v2.MetricIngestedIndexedVolume.html @@ -1,5 +1,5 @@ MetricIngestedIndexedVolume | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricIngestedIndexedVolume

Object for a single metric's ingested and indexed volume.

-

Hierarchy

  • MetricIngestedIndexedVolume

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricIngestedIndexedVolumeAttributes

Optional id

id?: string
+

Hierarchy

  • MetricIngestedIndexedVolume

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricIngestedIndexedVolumeAttributes

Optional id

id?: string

The metric name for this resource.

-

Optional type

type?: "metric_volumes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "metric_volumes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricIngestedIndexedVolumeAttributes.html b/classes/v2.MetricIngestedIndexedVolumeAttributes.html index 07f9ffb39a7..0136e148de2 100644 --- a/classes/v2.MetricIngestedIndexedVolumeAttributes.html +++ b/classes/v2.MetricIngestedIndexedVolumeAttributes.html @@ -1,7 +1,7 @@ MetricIngestedIndexedVolumeAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricIngestedIndexedVolumeAttributes

Object containing the definition of a metric's ingested and indexed volume.

-

Hierarchy

  • MetricIngestedIndexedVolumeAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional indexedVolume

indexedVolume?: number
+

Hierarchy

  • MetricIngestedIndexedVolumeAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional indexedVolume

indexedVolume?: number

Indexed volume for the given metric.

-

Optional ingestedVolume

ingestedVolume?: number
+

Optional ingestedVolume

ingestedVolume?: number

Ingested volume for the given metric.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfiguration.html b/classes/v2.MetricTagConfiguration.html index 04c179383df..b1f47ed353e 100644 --- a/classes/v2.MetricTagConfiguration.html +++ b/classes/v2.MetricTagConfiguration.html @@ -1,5 +1,5 @@ MetricTagConfiguration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfiguration

Object for a single metric tag configuration.

-

Hierarchy

  • MetricTagConfiguration

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricTagConfigurationAttributes

Optional id

id?: string
+

Hierarchy

  • MetricTagConfiguration

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricTagConfigurationAttributes

Optional id

id?: string

The metric name for this resource.

-

Optional type

type?: "manage_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "manage_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationAttributes.html b/classes/v2.MetricTagConfigurationAttributes.html index 211724c31ba..57b11dc7777 100644 --- a/classes/v2.MetricTagConfigurationAttributes.html +++ b/classes/v2.MetricTagConfigurationAttributes.html @@ -1,13 +1,13 @@ MetricTagConfigurationAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationAttributes

Object containing the definition of a metric tag configuration attributes.

-

Hierarchy

  • MetricTagConfigurationAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregations

aggregations?: MetricCustomAggregation[]
+

Hierarchy

  • MetricTagConfigurationAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregations

aggregations?: MetricCustomAggregation[]

A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a metric_type of count, rate, or gauge.

-

Optional createdAt

createdAt?: Date
+

Optional createdAt

createdAt?: Date

Timestamp when the tag configuration was created.

-

Optional includePercentiles

includePercentiles?: boolean
+

Optional includePercentiles

includePercentiles?: boolean

Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the metric_type is distribution.

-

Optional metricType

metricType?: MetricTagConfigurationMetricTypes

Optional modifiedAt

modifiedAt?: Date
+

Optional metricType

metricType?: MetricTagConfigurationMetricTypes

Optional modifiedAt

modifiedAt?: Date

Timestamp when the tag configuration was last modified.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

List of tag keys on which to group.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationCreateAttributes.html b/classes/v2.MetricTagConfigurationCreateAttributes.html index 4ca834eb4c4..f866ff0dad1 100644 --- a/classes/v2.MetricTagConfigurationCreateAttributes.html +++ b/classes/v2.MetricTagConfigurationCreateAttributes.html @@ -1,9 +1,9 @@ MetricTagConfigurationCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationCreateAttributes

Object containing the definition of a metric tag configuration to be created.

-

Hierarchy

  • MetricTagConfigurationCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregations

aggregations?: MetricCustomAggregation[]
+

Hierarchy

  • MetricTagConfigurationCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregations

aggregations?: MetricCustomAggregation[]

A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a metric_type of count, rate, or gauge.

-

Optional includePercentiles

includePercentiles?: boolean
+

Optional includePercentiles

includePercentiles?: boolean

Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a metric_type of distribution.

-

metricType

metricType: MetricTagConfigurationMetricTypes

tags

tags: string[]
+

metricType

metricType: MetricTagConfigurationMetricTypes

tags

tags: string[]

A list of tag keys that will be queryable for your metric.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationCreateData.html b/classes/v2.MetricTagConfigurationCreateData.html index 260aee4487d..f851458c792 100644 --- a/classes/v2.MetricTagConfigurationCreateData.html +++ b/classes/v2.MetricTagConfigurationCreateData.html @@ -1,5 +1,5 @@ MetricTagConfigurationCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationCreateData

Object for a single metric to be configure tags on.

-

Hierarchy

  • MetricTagConfigurationCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricTagConfigurationCreateAttributes

id

id: string
+

Hierarchy

  • MetricTagConfigurationCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricTagConfigurationCreateAttributes

id

id: string

The metric name for this resource.

-

type

type: "manage_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "manage_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationCreateRequest.html b/classes/v2.MetricTagConfigurationCreateRequest.html index 5eb53bfa359..447928308aa 100644 --- a/classes/v2.MetricTagConfigurationCreateRequest.html +++ b/classes/v2.MetricTagConfigurationCreateRequest.html @@ -1,3 +1,3 @@ MetricTagConfigurationCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationCreateRequest

Request object that includes the metric that you would like to configure tags for.

-

Hierarchy

  • MetricTagConfigurationCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricTagConfigurationCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricTagConfigurationCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricTagConfigurationCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationResponse.html b/classes/v2.MetricTagConfigurationResponse.html index ad0ef4f53da..0d38ee8a95f 100644 --- a/classes/v2.MetricTagConfigurationResponse.html +++ b/classes/v2.MetricTagConfigurationResponse.html @@ -1,3 +1,3 @@ MetricTagConfigurationResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationResponse

Response object which includes a single metric's tag configuration.

-

Hierarchy

  • MetricTagConfigurationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricTagConfiguration

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricTagConfigurationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricTagConfiguration

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationUpdateAttributes.html b/classes/v2.MetricTagConfigurationUpdateAttributes.html index 372367914dc..4b4e8c8b302 100644 --- a/classes/v2.MetricTagConfigurationUpdateAttributes.html +++ b/classes/v2.MetricTagConfigurationUpdateAttributes.html @@ -1,9 +1,9 @@ MetricTagConfigurationUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationUpdateAttributes

Object containing the definition of a metric tag configuration to be updated.

-

Hierarchy

  • MetricTagConfigurationUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregations

aggregations?: MetricCustomAggregation[]
+

Hierarchy

  • MetricTagConfigurationUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregations

aggregations?: MetricCustomAggregation[]

A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a metric_type of count, rate, or gauge.

-

Optional includePercentiles

includePercentiles?: boolean
+

Optional includePercentiles

includePercentiles?: boolean

Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a metric_type of distribution.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

A list of tag keys that will be queryable for your metric.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationUpdateData.html b/classes/v2.MetricTagConfigurationUpdateData.html index 1671543e3a8..358b1cff927 100644 --- a/classes/v2.MetricTagConfigurationUpdateData.html +++ b/classes/v2.MetricTagConfigurationUpdateData.html @@ -1,5 +1,5 @@ MetricTagConfigurationUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationUpdateData

Object for a single tag configuration to be edited.

-

Hierarchy

  • MetricTagConfigurationUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricTagConfigurationUpdateAttributes

id

id: string
+

Hierarchy

  • MetricTagConfigurationUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: MetricTagConfigurationUpdateAttributes

id

id: string

The metric name for this resource.

-

type

type: "manage_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "manage_tags"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricTagConfigurationUpdateRequest.html b/classes/v2.MetricTagConfigurationUpdateRequest.html index aad63f65397..7728efcb495 100644 --- a/classes/v2.MetricTagConfigurationUpdateRequest.html +++ b/classes/v2.MetricTagConfigurationUpdateRequest.html @@ -1,3 +1,3 @@ MetricTagConfigurationUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricTagConfigurationUpdateRequest

Request object that includes the metric that you would like to edit the tag configuration on.

-

Hierarchy

  • MetricTagConfigurationUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricTagConfigurationUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricTagConfigurationUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: MetricTagConfigurationUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricVolumesResponse.html b/classes/v2.MetricVolumesResponse.html index 081365cb9b5..9eab341e8dc 100644 --- a/classes/v2.MetricVolumesResponse.html +++ b/classes/v2.MetricVolumesResponse.html @@ -1,3 +1,3 @@ MetricVolumesResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricVolumesResponse

Response object which includes a single metric's volume.

-

Hierarchy

  • MetricVolumesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricVolumes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • MetricVolumesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricVolumes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricsAndMetricTagConfigurationsResponse.html b/classes/v2.MetricsAndMetricTagConfigurationsResponse.html index f04e5c54480..ba69249e077 100644 --- a/classes/v2.MetricsAndMetricTagConfigurationsResponse.html +++ b/classes/v2.MetricsAndMetricTagConfigurationsResponse.html @@ -1,5 +1,5 @@ MetricsAndMetricTagConfigurationsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricsAndMetricTagConfigurationsResponse

Response object that includes metrics and metric tag configurations.

-

Hierarchy

  • MetricsAndMetricTagConfigurationsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricsAndMetricTagConfigurations[]
+

Hierarchy

  • MetricsAndMetricTagConfigurationsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: MetricsAndMetricTagConfigurations[]

Array of metrics and metric tag configurations.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.MetricsApi.html b/classes/v2.MetricsApi.html index 499453eaa81..7b1e4142be6 100644 --- a/classes/v2.MetricsApi.html +++ b/classes/v2.MetricsApi.html @@ -1,36 +1,36 @@ -MetricsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricsApi

Hierarchy

  • MetricsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MetricsApi(configuration: v2.Configuration, requestFactory?: MetricsApiRequestFactory, responseProcessor?: MetricsApiResponseProcessor): v2.MetricsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: MetricsApiRequestFactory

Private responseProcessor

responseProcessor: MetricsApiResponseProcessor

Methods

createBulkTagsMetricsConfiguration

createTagConfiguration

deleteBulkTagsMetricsConfiguration

Returns Promise<MetricTagConfigurationResponse>

deleteBulkTagsMetricsConfiguration

deleteTagConfiguration

Returns Promise<MetricBulkTagConfigResponse>

deleteTagConfiguration

listTagConfigurationByName

Returns Promise<void>

listTagConfigurationByName

listTagConfigurations

Returns Promise<MetricTagConfigurationResponse>

listTagConfigurations

listTagsByMetricName

Returns Promise<MetricsAndMetricTagConfigurationsResponse>

listTagsByMetricName

listVolumesByMetricName

Returns Promise<MetricAllTagsResponse>

listVolumesByMetricName

updateTagConfiguration

Returns Promise<MetricVolumesResponse>

updateTagConfiguration

Hierarchy

  • NullableRelationshipToUser

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: null | NullableRelationshipToUserData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.NullableRelationshipToUserData.html b/classes/v2.NullableRelationshipToUserData.html index 2e236e6c976..0670dac25f7 100644 --- a/classes/v2.NullableRelationshipToUserData.html +++ b/classes/v2.NullableRelationshipToUserData.html @@ -1,5 +1,5 @@ NullableRelationshipToUserData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NullableRelationshipToUserData

Relationship to user object.

-

Hierarchy

  • NullableRelationshipToUserData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string
+

Hierarchy

  • NullableRelationshipToUserData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string

A unique identifier that represents the user.

-

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.Organization.html b/classes/v2.Organization.html index f045b038fe4..913fa07f214 100644 --- a/classes/v2.Organization.html +++ b/classes/v2.Organization.html @@ -1,5 +1,5 @@ Organization | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Organization

Organization object.

-

Hierarchy

  • Organization

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: OrganizationAttributes

Optional id

id?: string
+

Hierarchy

  • Organization

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: OrganizationAttributes

Optional id

id?: string

ID of the organization.

-

type

type: "orgs"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "orgs"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.OrganizationAttributes.html b/classes/v2.OrganizationAttributes.html index d05e0e4902c..17fac5522a8 100644 --- a/classes/v2.OrganizationAttributes.html +++ b/classes/v2.OrganizationAttributes.html @@ -1,19 +1,19 @@ OrganizationAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationAttributes

Attributes of the organization.

-

Hierarchy

  • OrganizationAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • OrganizationAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the organization.

-

Optional description

description?: string
+

Optional description

description?: string

Description of the organization.

-

Optional disabled

disabled?: boolean
+

Optional disabled

disabled?: boolean

Whether or not the organization is disabled.

-

Optional modifiedAt

modifiedAt?: Date
+

Optional modifiedAt

modifiedAt?: Date

Time of last organization modification.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the organization.

-

Optional publicId

publicId?: string
+

Optional publicId

publicId?: string

Public ID of the organization.

-

Optional sharing

sharing?: string
+

Optional sharing

sharing?: string

Sharing type of the organization.

-

Optional url

url?: string
+

Optional url

url?: string

URL of the site that this organization exists at.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.Pagination.html b/classes/v2.Pagination.html index 0520f6774c0..b96f57b2c58 100644 --- a/classes/v2.Pagination.html +++ b/classes/v2.Pagination.html @@ -1,7 +1,7 @@ Pagination | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pagination

Pagination object.

-

Hierarchy

  • Pagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number
+

Hierarchy

  • Pagination

Index

Constructors

Properties

Constructors

constructor

Properties

Optional totalCount

totalCount?: number

Total count.

-

Optional totalFilteredCount

totalFilteredCount?: number
+

Optional totalFilteredCount

totalFilteredCount?: number

Total count of elements matched by the filter.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PartialAPIKey.html b/classes/v2.PartialAPIKey.html index 488d2f5f617..a1411d0c826 100644 --- a/classes/v2.PartialAPIKey.html +++ b/classes/v2.PartialAPIKey.html @@ -1,5 +1,5 @@ PartialAPIKey | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PartialAPIKey

Partial Datadog API key.

-

Hierarchy

  • PartialAPIKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: PartialAPIKeyAttributes

Optional id

id?: string
+

Hierarchy

  • PartialAPIKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: PartialAPIKeyAttributes

Optional id

id?: string

ID of the API key.

-

Optional relationships

relationships?: APIKeyRelationships

Optional type

type?: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: APIKeyRelationships

Optional type

type?: "api_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PartialAPIKeyAttributes.html b/classes/v2.PartialAPIKeyAttributes.html index 2f370732704..fdc0d70f1a9 100644 --- a/classes/v2.PartialAPIKeyAttributes.html +++ b/classes/v2.PartialAPIKeyAttributes.html @@ -1,11 +1,11 @@ PartialAPIKeyAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PartialAPIKeyAttributes

Attributes of a partial API key.

-

Hierarchy

  • PartialAPIKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string
+

Hierarchy

  • PartialAPIKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string

Creation date of the API key.

-

Optional last4

last4?: string
+

Optional last4

last4?: string

The last four characters of the API key.

-

Optional modifiedAt

modifiedAt?: string
+

Optional modifiedAt

modifiedAt?: string

Date the API key was last modified.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the API key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PartialApplicationKey.html b/classes/v2.PartialApplicationKey.html index 624fe55f41c..270517936de 100644 --- a/classes/v2.PartialApplicationKey.html +++ b/classes/v2.PartialApplicationKey.html @@ -1,5 +1,5 @@ PartialApplicationKey | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PartialApplicationKey

Partial Datadog application key.

-

Hierarchy

  • PartialApplicationKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: PartialApplicationKeyAttributes

Optional id

id?: string
+

Hierarchy

  • PartialApplicationKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: PartialApplicationKeyAttributes

Optional id

id?: string

ID of the application key.

-

Optional relationships

relationships?: ApplicationKeyRelationships

Optional type

type?: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: ApplicationKeyRelationships

Optional type

type?: "application_keys"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PartialApplicationKeyAttributes.html b/classes/v2.PartialApplicationKeyAttributes.html index a4a937fcc3e..2241de1fd13 100644 --- a/classes/v2.PartialApplicationKeyAttributes.html +++ b/classes/v2.PartialApplicationKeyAttributes.html @@ -1,11 +1,11 @@ PartialApplicationKeyAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PartialApplicationKeyAttributes

Attributes of a partial application key.

-

Hierarchy

  • PartialApplicationKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string
+

Hierarchy

  • PartialApplicationKeyAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: string

Creation date of the application key.

-

Optional last4

last4?: string
+

Optional last4

last4?: string

The last four characters of the application key.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the application key.

-

Optional scopes

scopes?: string[]
+

Optional scopes

scopes?: string[]

Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PartialApplicationKeyResponse.html b/classes/v2.PartialApplicationKeyResponse.html index cf9e0ba089b..040309f63ca 100644 --- a/classes/v2.PartialApplicationKeyResponse.html +++ b/classes/v2.PartialApplicationKeyResponse.html @@ -1,5 +1,5 @@ PartialApplicationKeyResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PartialApplicationKeyResponse

Response for retrieving a partial application key.

-

Hierarchy

  • PartialApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: PartialApplicationKey

Optional included

included?: ApplicationKeyResponseIncludedItem[]
+

Hierarchy

  • PartialApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: PartialApplicationKey

Optional included

included?: ApplicationKeyResponseIncludedItem[]

Array of objects related to the application key.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.Permission.html b/classes/v2.Permission.html index 70489ef09fc..d92941cb3de 100644 --- a/classes/v2.Permission.html +++ b/classes/v2.Permission.html @@ -1,5 +1,5 @@ Permission | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Permission

Permission object.

-

Hierarchy

  • Permission

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: PermissionAttributes

Optional id

id?: string
+

Hierarchy

  • Permission

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: PermissionAttributes

Optional id

id?: string

ID of the permission.

-

type

type: "permissions"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "permissions"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PermissionAttributes.html b/classes/v2.PermissionAttributes.html index 27b3dc8ee3a..219ec3ec7d8 100644 --- a/classes/v2.PermissionAttributes.html +++ b/classes/v2.PermissionAttributes.html @@ -1,17 +1,17 @@ PermissionAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PermissionAttributes

Attributes of a permission.

-

Hierarchy

  • PermissionAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date
+

Hierarchy

  • PermissionAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: Date

Creation time of the permission.

-

Optional description

description?: string
+

Optional description

description?: string

Description of the permission.

-

Optional displayName

displayName?: string
+

Optional displayName

displayName?: string

Displayed name for the permission.

-

Optional displayType

displayType?: string
+

Optional displayType

displayType?: string

Display type.

-

Optional groupName

groupName?: string
+

Optional groupName

groupName?: string

Name of the permission group.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the permission.

-

Optional restricted

restricted?: boolean
+

Optional restricted

restricted?: boolean

Whether or not the permission is restricted.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.PermissionsResponse.html b/classes/v2.PermissionsResponse.html index 89280eb9ce1..1c64a407720 100644 --- a/classes/v2.PermissionsResponse.html +++ b/classes/v2.PermissionsResponse.html @@ -1,5 +1,5 @@ PermissionsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PermissionsResponse

Payload with API-returned permissions.

-

Hierarchy

  • PermissionsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: Permission[]
+

Hierarchy

  • PermissionsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: Permission[]

Array of permissions.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ProcessSummariesMeta.html b/classes/v2.ProcessSummariesMeta.html index c79035b76ca..b57b7dc4495 100644 --- a/classes/v2.ProcessSummariesMeta.html +++ b/classes/v2.ProcessSummariesMeta.html @@ -1,3 +1,3 @@ ProcessSummariesMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessSummariesMeta

Response metadata object.

-

Hierarchy

  • ProcessSummariesMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: ProcessSummariesMetaPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ProcessSummariesMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: ProcessSummariesMetaPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ProcessSummariesMetaPage.html b/classes/v2.ProcessSummariesMetaPage.html index efab3c56cf8..9194eb88a98 100644 --- a/classes/v2.ProcessSummariesMetaPage.html +++ b/classes/v2.ProcessSummariesMetaPage.html @@ -1,7 +1,7 @@ ProcessSummariesMetaPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessSummariesMetaPage

Paging attributes.

-

Hierarchy

  • ProcessSummariesMetaPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional after

after?: string
+

Hierarchy

  • ProcessSummariesMetaPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional after

after?: string

The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

-

Optional size

size?: number
+

Optional size

size?: number

Number of results returned.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ProcessSummariesResponse.html b/classes/v2.ProcessSummariesResponse.html index b8151212e0b..5f63410bd43 100644 --- a/classes/v2.ProcessSummariesResponse.html +++ b/classes/v2.ProcessSummariesResponse.html @@ -1,5 +1,5 @@ ProcessSummariesResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessSummariesResponse

List of process summaries.

-

Hierarchy

  • ProcessSummariesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: ProcessSummary[]
+

Hierarchy

  • ProcessSummariesResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: ProcessSummary[]

Array of process summary objects.

-

Optional meta

meta?: ProcessSummariesMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional meta

meta?: ProcessSummariesMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ProcessSummary.html b/classes/v2.ProcessSummary.html index 9a4d37b7507..1a1f68cadf3 100644 --- a/classes/v2.ProcessSummary.html +++ b/classes/v2.ProcessSummary.html @@ -1,5 +1,5 @@ ProcessSummary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessSummary

Process summary object.

-

Hierarchy

  • ProcessSummary

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: ProcessSummaryAttributes

Optional id

id?: string
+

Hierarchy

  • ProcessSummary

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: ProcessSummaryAttributes

Optional id

id?: string

Process ID.

-

Optional type

type?: "process"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "process"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ProcessSummaryAttributes.html b/classes/v2.ProcessSummaryAttributes.html index c76c206caa1..0bca5c18ab7 100644 --- a/classes/v2.ProcessSummaryAttributes.html +++ b/classes/v2.ProcessSummaryAttributes.html @@ -1,19 +1,19 @@ ProcessSummaryAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessSummaryAttributes

Attributes for a process summary.

-

Hierarchy

  • ProcessSummaryAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cmdline

cmdline?: string
+

Hierarchy

  • ProcessSummaryAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cmdline

cmdline?: string

Process command line.

-

Optional host

host?: string
+

Optional host

host?: string

Host running the process.

-

Optional pid

pid?: number
+

Optional pid

pid?: number

Process ID.

-

Optional ppid

ppid?: number
+

Optional ppid

ppid?: number

Parent process ID.

-

Optional start

start?: string
+

Optional start

start?: string

Time the process was started.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

List of tags associated with the process.

-

Optional timestamp

timestamp?: string
+

Optional timestamp

timestamp?: string

Time the process was seen.

-

Optional user

user?: string
+

Optional user

user?: string

Process owner.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ProcessesApi.html b/classes/v2.ProcessesApi.html index 5bc1ed51726..9e6d27aeb58 100644 --- a/classes/v2.ProcessesApi.html +++ b/classes/v2.ProcessesApi.html @@ -1,4 +1,4 @@ -ProcessesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessesApi

Hierarchy

  • ProcessesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ProcessesApi(configuration: v2.Configuration, requestFactory?: ProcessesApiRequestFactory, responseProcessor?: ProcessesApiResponseProcessor): ProcessesApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: ProcessesApiRequestFactory

Private responseProcessor

responseProcessor: ProcessesApiResponseProcessor

Methods

listProcesses

Hierarchy

  • RelationshipToIncidentPostmortem

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToIncidentPostmortemData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToIncidentPostmortemData.html b/classes/v2.RelationshipToIncidentPostmortemData.html index 1031feaa2ec..a96bb22cc44 100644 --- a/classes/v2.RelationshipToIncidentPostmortemData.html +++ b/classes/v2.RelationshipToIncidentPostmortemData.html @@ -1,5 +1,5 @@ RelationshipToIncidentPostmortemData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToIncidentPostmortemData

The postmortem relationship data.

-

Hierarchy

  • RelationshipToIncidentPostmortemData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string
+

Hierarchy

  • RelationshipToIncidentPostmortemData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string

A unique identifier that represents the postmortem.

-

type

type: "incident_postmortems"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "incident_postmortems"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToOrganization.html b/classes/v2.RelationshipToOrganization.html index 8e4a6bb5bd8..f27344baeb8 100644 --- a/classes/v2.RelationshipToOrganization.html +++ b/classes/v2.RelationshipToOrganization.html @@ -1,3 +1,3 @@ RelationshipToOrganization | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToOrganization

Relationship to an organization.

-

Hierarchy

  • RelationshipToOrganization

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToOrganizationData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RelationshipToOrganization

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToOrganizationData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToOrganizationData.html b/classes/v2.RelationshipToOrganizationData.html index 4f4597a306c..8e44ce1b551 100644 --- a/classes/v2.RelationshipToOrganizationData.html +++ b/classes/v2.RelationshipToOrganizationData.html @@ -1,5 +1,5 @@ RelationshipToOrganizationData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToOrganizationData

Relationship to organization object.

-

Hierarchy

  • RelationshipToOrganizationData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string
+

Hierarchy

  • RelationshipToOrganizationData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string

ID of the organization.

-

type

type: "orgs"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "orgs"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToOrganizations.html b/classes/v2.RelationshipToOrganizations.html index 3532c84fe2a..14bc87c2e6f 100644 --- a/classes/v2.RelationshipToOrganizations.html +++ b/classes/v2.RelationshipToOrganizations.html @@ -1,5 +1,5 @@ RelationshipToOrganizations | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToOrganizations

Relationship to organizations.

-

Hierarchy

  • RelationshipToOrganizations

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToOrganizationData[]
+

Hierarchy

  • RelationshipToOrganizations

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToOrganizationData[]

Relationships to organization objects.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToPermission.html b/classes/v2.RelationshipToPermission.html index 31cd9e0238b..e8c32578470 100644 --- a/classes/v2.RelationshipToPermission.html +++ b/classes/v2.RelationshipToPermission.html @@ -1,3 +1,3 @@ RelationshipToPermission | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToPermission

Relationship to a permissions object.

-

Hierarchy

  • RelationshipToPermission

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToPermissionData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RelationshipToPermission

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToPermissionData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToPermissionData.html b/classes/v2.RelationshipToPermissionData.html index f3dda98bb59..720a232f885 100644 --- a/classes/v2.RelationshipToPermissionData.html +++ b/classes/v2.RelationshipToPermissionData.html @@ -1,5 +1,5 @@ RelationshipToPermissionData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToPermissionData

Relationship to permission object.

-

Hierarchy

  • RelationshipToPermissionData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string
+

Hierarchy

  • RelationshipToPermissionData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string

ID of the permission.

-

Optional type

type?: "permissions"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "permissions"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToPermissions.html b/classes/v2.RelationshipToPermissions.html index c979c1a8d42..456c03f77f0 100644 --- a/classes/v2.RelationshipToPermissions.html +++ b/classes/v2.RelationshipToPermissions.html @@ -1,5 +1,5 @@ RelationshipToPermissions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToPermissions

Relationship to multiple permissions objects.

-

Hierarchy

  • RelationshipToPermissions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToPermissionData[]
+

Hierarchy

  • RelationshipToPermissions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToPermissionData[]

Relationships to permission objects.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToRole.html b/classes/v2.RelationshipToRole.html index 0d7aec6adf0..3cf35816bea 100644 --- a/classes/v2.RelationshipToRole.html +++ b/classes/v2.RelationshipToRole.html @@ -1,3 +1,3 @@ RelationshipToRole | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToRole

Relationship to role.

-

Hierarchy

  • RelationshipToRole

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToRoleData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RelationshipToRole

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToRoleData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToRoleData.html b/classes/v2.RelationshipToRoleData.html index af4ab36b918..1ef662e5ff3 100644 --- a/classes/v2.RelationshipToRoleData.html +++ b/classes/v2.RelationshipToRoleData.html @@ -1,5 +1,5 @@ RelationshipToRoleData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToRoleData

Relationship to role object.

-

Hierarchy

  • RelationshipToRoleData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string
+

Hierarchy

  • RelationshipToRoleData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional id

id?: string

ID of the role.

-

Optional type

type?: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToRoles.html b/classes/v2.RelationshipToRoles.html index 3f69cd0d503..dda73592249 100644 --- a/classes/v2.RelationshipToRoles.html +++ b/classes/v2.RelationshipToRoles.html @@ -1,5 +1,5 @@ RelationshipToRoles | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToRoles

Relationship to roles.

-

Hierarchy

  • RelationshipToRoles

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToRoleData[]
+

Hierarchy

  • RelationshipToRoles

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RelationshipToRoleData[]

An array containing type and ID of a role.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToSAMLAssertionAttribute.html b/classes/v2.RelationshipToSAMLAssertionAttribute.html index 52bfd3ebcb8..ceb415aac22 100644 --- a/classes/v2.RelationshipToSAMLAssertionAttribute.html +++ b/classes/v2.RelationshipToSAMLAssertionAttribute.html @@ -1,3 +1,3 @@ RelationshipToSAMLAssertionAttribute | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToSAMLAssertionAttribute

AuthN Mapping relationship to SAML Assertion Attribute.

-

Hierarchy

  • RelationshipToSAMLAssertionAttribute

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToSAMLAssertionAttributeData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RelationshipToSAMLAssertionAttribute

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToSAMLAssertionAttributeData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToSAMLAssertionAttributeData.html b/classes/v2.RelationshipToSAMLAssertionAttributeData.html index 2d92e109f92..10855279ddb 100644 --- a/classes/v2.RelationshipToSAMLAssertionAttributeData.html +++ b/classes/v2.RelationshipToSAMLAssertionAttributeData.html @@ -1,5 +1,5 @@ RelationshipToSAMLAssertionAttributeData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToSAMLAssertionAttributeData

Data of AuthN Mapping relationship to SAML Assertion Attribute.

-

Hierarchy

  • RelationshipToSAMLAssertionAttributeData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: number
+

Hierarchy

  • RelationshipToSAMLAssertionAttributeData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: number

The ID of the SAML assertion attribute.

-

type

type: "saml_assertion_attributes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "saml_assertion_attributes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToUser.html b/classes/v2.RelationshipToUser.html index 6cd4958f190..39dc7b3a85c 100644 --- a/classes/v2.RelationshipToUser.html +++ b/classes/v2.RelationshipToUser.html @@ -1,3 +1,3 @@ RelationshipToUser | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToUser

Relationship to user.

-

Hierarchy

  • RelationshipToUser

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToUserData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RelationshipToUser

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToUserData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToUserData.html b/classes/v2.RelationshipToUserData.html index 83c066b5a9b..bff44244b25 100644 --- a/classes/v2.RelationshipToUserData.html +++ b/classes/v2.RelationshipToUserData.html @@ -1,5 +1,5 @@ RelationshipToUserData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToUserData

Relationship to user object.

-

Hierarchy

  • RelationshipToUserData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string
+

Hierarchy

  • RelationshipToUserData

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: string

A unique identifier that represents the user.

-

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RelationshipToUsers.html b/classes/v2.RelationshipToUsers.html index 13141df2910..309baa15fab 100644 --- a/classes/v2.RelationshipToUsers.html +++ b/classes/v2.RelationshipToUsers.html @@ -1,5 +1,5 @@ RelationshipToUsers | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipToUsers

Relationship to users.

-

Hierarchy

  • RelationshipToUsers

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToUserData[]
+

Hierarchy

  • RelationshipToUsers

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RelationshipToUserData[]

Relationships to user objects.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RequestContext.html b/classes/v2.RequestContext.html index d5d2381b7d5..9c94c44ce2f 100644 --- a/classes/v2.RequestContext.html +++ b/classes/v2.RequestContext.html @@ -1,20 +1,20 @@ RequestContext | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequestContext

Represents an HTTP request context

-

Hierarchy

  • RequestContext

Index

Constructors

Properties

Methods

Constructors

constructor

Hierarchy

  • RequestContext

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private body

body: v2.RequestBody = undefined

Private headers

headers: {} = ...

Type declaration

  • [key: string]: string

Private httpConfig

httpConfig: v2.HttpConfiguration = {}

Private url

url: URLParse

Methods

addCookie

  • addCookie(name: string, value: string): void

Returns v2.RequestContext

Properties

Private body

body: v2.RequestBody = undefined

Private headers

headers: {} = ...

Type declaration

  • [key: string]: string

Private httpConfig

httpConfig: v2.HttpConfiguration = {}

Private url

url: URLParse

Methods

addCookie

  • addCookie(name: string, value: string): void

getBody

getHeaders

  • getHeaders(): {}

getHttpConfig

getHttpMethod

getUrl

  • getUrl(): string

setBody

getBody

getHeaders

  • getHeaders(): {}

getHttpConfig

getHttpMethod

getUrl

  • getUrl(): string

setBody

setHeaderParam

  • setHeaderParam(key: string, value: string): void

setHttpConfig

setQueryParam

  • setQueryParam(name: string, value: string): void

setUrl

  • setUrl(url: string): void

Returns void

setHeaderParam

  • setHeaderParam(key: string, value: string): void

setHttpConfig

setQueryParam

  • setQueryParam(name: string, value: string): void

setUrl

  • setUrl(url: string): void

Legend

  • Constructor
  • Method
  • Private property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ResponseContext.html b/classes/v2.ResponseContext.html index 6720a760f03..c5cfc187a8b 100644 --- a/classes/v2.ResponseContext.html +++ b/classes/v2.ResponseContext.html @@ -1,4 +1,4 @@ -ResponseContext | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResponseContext

Hierarchy

  • ResponseContext

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: v2.ResponseBody

headers

headers: {}

Type declaration

  • [key: string]: string

httpStatusCode

httpStatusCode: number

Methods

getBodyAsFile

getParsedHeader

  • getParsedHeader(headerName: string): {}

Optional relationships

relationships?: RoleResponseRelationships

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleAttributes.html b/classes/v2.RoleAttributes.html index 560c45cd534..56324674a1d 100644 --- a/classes/v2.RoleAttributes.html +++ b/classes/v2.RoleAttributes.html @@ -1,11 +1,11 @@ RoleAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleAttributes

Attributes of the role.

-

Hierarchy

  • RoleAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • RoleAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the role.

-

Optional modifiedAt

modifiedAt?: Date
+

Optional modifiedAt

modifiedAt?: Date

Time of last role modification.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the role.

-

Optional userCount

userCount?: number
+

Optional userCount

userCount?: number

Number of users with that role.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleClone.html b/classes/v2.RoleClone.html index 1a863773ef3..14f0fd2ad53 100644 --- a/classes/v2.RoleClone.html +++ b/classes/v2.RoleClone.html @@ -1,3 +1,3 @@ RoleClone | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleClone

Data for the clone role request.

-

Hierarchy

  • RoleClone

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: RoleCloneAttributes

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleClone

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: RoleCloneAttributes

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCloneAttributes.html b/classes/v2.RoleCloneAttributes.html index 82cbf0a1235..03fb00ed419 100644 --- a/classes/v2.RoleCloneAttributes.html +++ b/classes/v2.RoleCloneAttributes.html @@ -1,5 +1,5 @@ RoleCloneAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCloneAttributes

Attributes required to create a new role by cloning an existing one.

-

Hierarchy

  • RoleCloneAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • RoleCloneAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Name of the new role that is cloned.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCloneRequest.html b/classes/v2.RoleCloneRequest.html index 630f02b2465..5b93ba41413 100644 --- a/classes/v2.RoleCloneRequest.html +++ b/classes/v2.RoleCloneRequest.html @@ -1,3 +1,3 @@ RoleCloneRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCloneRequest

Request to create a role by cloning an existing role.

-

Hierarchy

  • RoleCloneRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RoleClone

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleCloneRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RoleClone

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCreateAttributes.html b/classes/v2.RoleCreateAttributes.html index 6622cca11e8..caa255567c3 100644 --- a/classes/v2.RoleCreateAttributes.html +++ b/classes/v2.RoleCreateAttributes.html @@ -1,9 +1,9 @@ RoleCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCreateAttributes

Attributes of the created role.

-

Hierarchy

  • RoleCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • RoleCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the role.

-

Optional modifiedAt

modifiedAt?: Date
+

Optional modifiedAt

modifiedAt?: Date

Time of last role modification.

-

name

name: string
+

name

name: string

Name of the role.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCreateData.html b/classes/v2.RoleCreateData.html index b8cc6349df8..b0e0fe17a77 100644 --- a/classes/v2.RoleCreateData.html +++ b/classes/v2.RoleCreateData.html @@ -1,3 +1,3 @@ RoleCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCreateData

Data related to the creation of a role.

-

Hierarchy

  • RoleCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: RoleCreateAttributes

Optional relationships

relationships?: RoleRelationships

Optional type

type?: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: RoleCreateAttributes

Optional relationships

relationships?: RoleRelationships

Optional type

type?: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCreateRequest.html b/classes/v2.RoleCreateRequest.html index 6050d157628..234f3f3245e 100644 --- a/classes/v2.RoleCreateRequest.html +++ b/classes/v2.RoleCreateRequest.html @@ -1,3 +1,3 @@ RoleCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCreateRequest

Create a role.

-

Hierarchy

  • RoleCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RoleCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RoleCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCreateResponse.html b/classes/v2.RoleCreateResponse.html index d6ef8904af8..7e9d7ea82c6 100644 --- a/classes/v2.RoleCreateResponse.html +++ b/classes/v2.RoleCreateResponse.html @@ -1,3 +1,3 @@ RoleCreateResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCreateResponse

Response containing information about a created role.

-

Hierarchy

  • RoleCreateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RoleCreateResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleCreateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RoleCreateResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleCreateResponseData.html b/classes/v2.RoleCreateResponseData.html index b805b4d6849..2699d0168c5 100644 --- a/classes/v2.RoleCreateResponseData.html +++ b/classes/v2.RoleCreateResponseData.html @@ -1,5 +1,5 @@ RoleCreateResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleCreateResponseData

Role object returned by the API.

-

Hierarchy

  • RoleCreateResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: RoleCreateAttributes

Optional id

id?: string
+

Hierarchy

  • RoleCreateResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: RoleCreateAttributes

Optional id

id?: string

ID of the role.

-

Optional relationships

relationships?: RoleResponseRelationships

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: RoleResponseRelationships

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleRelationships.html b/classes/v2.RoleRelationships.html index c8e7ffe08fd..2fea9e52d04 100644 --- a/classes/v2.RoleRelationships.html +++ b/classes/v2.RoleRelationships.html @@ -1,3 +1,3 @@ RoleRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleRelationships

Relationships of the role object.

-

Hierarchy

  • RoleRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional permissions

permissions?: RelationshipToPermissions

Optional users

users?: RelationshipToUsers

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional permissions

permissions?: RelationshipToPermissions

Optional users

users?: RelationshipToUsers

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleResponse.html b/classes/v2.RoleResponse.html index 0e7d25a36ce..0fba66bf4a8 100644 --- a/classes/v2.RoleResponse.html +++ b/classes/v2.RoleResponse.html @@ -1,3 +1,3 @@ RoleResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleResponse

Response containing information about a single role.

-

Hierarchy

  • RoleResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: Role

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: Role

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleResponseRelationships.html b/classes/v2.RoleResponseRelationships.html index 4e13c1e2bc0..39474c507f4 100644 --- a/classes/v2.RoleResponseRelationships.html +++ b/classes/v2.RoleResponseRelationships.html @@ -1,3 +1,3 @@ RoleResponseRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleResponseRelationships

Relationships of the role object returned by the API.

-

Hierarchy

  • RoleResponseRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional permissions

permissions?: RelationshipToPermissions

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleResponseRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional permissions

permissions?: RelationshipToPermissions

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleUpdateAttributes.html b/classes/v2.RoleUpdateAttributes.html index 87633cbc85b..dc2015a1b93 100644 --- a/classes/v2.RoleUpdateAttributes.html +++ b/classes/v2.RoleUpdateAttributes.html @@ -1,9 +1,9 @@ RoleUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleUpdateAttributes

Attributes of the role.

-

Hierarchy

  • RoleUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • RoleUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the role.

-

Optional modifiedAt

modifiedAt?: Date
+

Optional modifiedAt

modifiedAt?: Date

Time of last role modification.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the role.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleUpdateData.html b/classes/v2.RoleUpdateData.html index c156b42eaa9..41de46cd212 100644 --- a/classes/v2.RoleUpdateData.html +++ b/classes/v2.RoleUpdateData.html @@ -1,5 +1,5 @@ RoleUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleUpdateData

Data related to the update of a role.

-

Hierarchy

  • RoleUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: RoleUpdateAttributes

id

id: string
+

Hierarchy

  • RoleUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: RoleUpdateAttributes

id

id: string

ID of the role.

-

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleUpdateRequest.html b/classes/v2.RoleUpdateRequest.html index e55fcba3ae0..22917596d79 100644 --- a/classes/v2.RoleUpdateRequest.html +++ b/classes/v2.RoleUpdateRequest.html @@ -1,3 +1,3 @@ RoleUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleUpdateRequest

Update a role.

-

Hierarchy

  • RoleUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RoleUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: RoleUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleUpdateResponse.html b/classes/v2.RoleUpdateResponse.html index 8f3c3c03411..eb47211ff23 100644 --- a/classes/v2.RoleUpdateResponse.html +++ b/classes/v2.RoleUpdateResponse.html @@ -1,3 +1,3 @@ RoleUpdateResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleUpdateResponse

Response containing information about an updated role.

-

Hierarchy

  • RoleUpdateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RoleUpdateResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • RoleUpdateResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: RoleUpdateResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RoleUpdateResponseData.html b/classes/v2.RoleUpdateResponseData.html index 817da7f3348..544e5ebd049 100644 --- a/classes/v2.RoleUpdateResponseData.html +++ b/classes/v2.RoleUpdateResponseData.html @@ -1,5 +1,5 @@ RoleUpdateResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoleUpdateResponseData

Role object returned by the API.

-

Hierarchy

  • RoleUpdateResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: RoleUpdateAttributes

Optional id

id?: string
+

Hierarchy

  • RoleUpdateResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: RoleUpdateAttributes

Optional id

id?: string

ID of the role.

-

Optional relationships

relationships?: RoleResponseRelationships

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional relationships

relationships?: RoleResponseRelationships

type

type: "roles"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.RolesApi.html b/classes/v2.RolesApi.html index a6307d14760..245ec559c59 100644 --- a/classes/v2.RolesApi.html +++ b/classes/v2.RolesApi.html @@ -1,50 +1,50 @@ -RolesApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RolesApi

Hierarchy

  • RolesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RolesApi(configuration: v2.Configuration, requestFactory?: RolesApiRequestFactory, responseProcessor?: RolesApiResponseProcessor): RolesApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: RolesApiRequestFactory

Private responseProcessor

responseProcessor: RolesApiResponseProcessor

Methods

addPermissionToRole

addUserToRole

cloneRole

Returns Promise<UsersResponse>

cloneRole

createRole

Returns Promise<RoleResponse>

createRole

deleteRole

Returns Promise<RoleCreateResponse>

deleteRole

getRole

Returns Promise<void>

getRole

listPermissions

Returns Promise<RoleResponse>

listPermissions

listRolePermissions

listRolePermissions

listRoleUsers

Returns Promise<PermissionsResponse>

listRoleUsers

listRoles

Returns Promise<UsersResponse>

listRoles

removePermissionFromRole

Returns Promise<RolesResponse>

removePermissionFromRole

removeUserFromRole

Returns Promise<PermissionsResponse>

removeUserFromRole

updateRole

Returns Promise<UsersResponse>

updateRole

Optional meta

meta?: v2.ResponseMetaAttributes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SAMLAssertionAttribute.html b/classes/v2.SAMLAssertionAttribute.html index f37b5971fe0..adff4826b63 100644 --- a/classes/v2.SAMLAssertionAttribute.html +++ b/classes/v2.SAMLAssertionAttribute.html @@ -1,5 +1,5 @@ SAMLAssertionAttribute | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SAMLAssertionAttribute

SAML assertion attribute.

-

Hierarchy

  • SAMLAssertionAttribute

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SAMLAssertionAttributeAttributes

id

id: number
+

Hierarchy

  • SAMLAssertionAttribute

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SAMLAssertionAttributeAttributes

id

id: number

The ID of the SAML assertion attribute.

-

type

type: "saml_assertion_attributes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "saml_assertion_attributes"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SAMLAssertionAttributeAttributes.html b/classes/v2.SAMLAssertionAttributeAttributes.html index 975b8a146da..f905eacd886 100644 --- a/classes/v2.SAMLAssertionAttributeAttributes.html +++ b/classes/v2.SAMLAssertionAttributeAttributes.html @@ -1,7 +1,7 @@ SAMLAssertionAttributeAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SAMLAssertionAttributeAttributes

Key/Value pair of attributes used in SAML assertion attributes.

-

Hierarchy

  • SAMLAssertionAttributeAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string
+

Hierarchy

  • SAMLAssertionAttributeAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributeKey

attributeKey?: string

Key portion of a key/value pair of the attribute sent from the Identity Provider.

-

Optional attributeValue

attributeValue?: string
+

Optional attributeValue

attributeValue?: string

Value portion of a key/value pair of the attribute sent from the Identity Provider.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilter.html b/classes/v2.SecurityFilter.html index a9e568c3b47..5bae95c7030 100644 --- a/classes/v2.SecurityFilter.html +++ b/classes/v2.SecurityFilter.html @@ -1,5 +1,5 @@ SecurityFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilter

The security filter's properties.

-

Hierarchy

  • SecurityFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SecurityFilterAttributes

Optional id

id?: string
+

Hierarchy

  • SecurityFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SecurityFilterAttributes

Optional id

id?: string

The ID of the security filter.

-

Optional type

type?: "security_filters"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "security_filters"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterAttributes.html b/classes/v2.SecurityFilterAttributes.html index dc02a1b3204..c3744e4e2f3 100644 --- a/classes/v2.SecurityFilterAttributes.html +++ b/classes/v2.SecurityFilterAttributes.html @@ -1,15 +1,15 @@ SecurityFilterAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterAttributes

The object describing a security filter.

-

Hierarchy

  • SecurityFilterAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional exclusionFilters

exclusionFilters?: SecurityFilterExclusionFilterResponse[]
+

Hierarchy

  • SecurityFilterAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional exclusionFilters

exclusionFilters?: SecurityFilterExclusionFilterResponse[]

The list of exclusion filters applied in this security filter.

-

Optional filteredDataType

filteredDataType?: "logs"

Optional isBuiltin

isBuiltin?: boolean
+

Optional filteredDataType

filteredDataType?: "logs"

Optional isBuiltin

isBuiltin?: boolean

Whether the security filter is the built-in filter.

-

Optional isEnabled

isEnabled?: boolean
+

Optional isEnabled

isEnabled?: boolean

Whether the security filter is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

The security filter name.

-

Optional query

query?: string
+

Optional query

query?: string

The security filter query. Logs accepted by this query will be accepted by this filter.

-

Optional version

version?: number
+

Optional version

version?: number

The version of the security filter.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterCreateAttributes.html b/classes/v2.SecurityFilterCreateAttributes.html index e5835fff5b5..2f323696ca1 100644 --- a/classes/v2.SecurityFilterCreateAttributes.html +++ b/classes/v2.SecurityFilterCreateAttributes.html @@ -1,11 +1,11 @@ SecurityFilterCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterCreateAttributes

Object containing the attributes of the security filter to be created.

-

Hierarchy

  • SecurityFilterCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

exclusionFilters

exclusionFilters: SecurityFilterExclusionFilter[]
+

Hierarchy

  • SecurityFilterCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

exclusionFilters

exclusionFilters: SecurityFilterExclusionFilter[]

Exclusion filters to exclude some logs from the security filter.

-

filteredDataType

filteredDataType: "logs"

isEnabled

isEnabled: boolean
+

filteredDataType

filteredDataType: "logs"

isEnabled

isEnabled: boolean

Whether the security filter is enabled.

-

name

name: string
+

name

name: string

The name of the security filter.

-

query

query: string
+

query

query: string

The query of the security filter.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterCreateData.html b/classes/v2.SecurityFilterCreateData.html index 6eba1eca70e..140aab48d3b 100644 --- a/classes/v2.SecurityFilterCreateData.html +++ b/classes/v2.SecurityFilterCreateData.html @@ -1,3 +1,3 @@ SecurityFilterCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterCreateData

Object for a single security filter.

-

Hierarchy

  • SecurityFilterCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: SecurityFilterCreateAttributes

type

type: "security_filters"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityFilterCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: SecurityFilterCreateAttributes

type

type: "security_filters"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterCreateRequest.html b/classes/v2.SecurityFilterCreateRequest.html index fb7b0b51ca0..3d12938e6fd 100644 --- a/classes/v2.SecurityFilterCreateRequest.html +++ b/classes/v2.SecurityFilterCreateRequest.html @@ -1,3 +1,3 @@ SecurityFilterCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterCreateRequest

Request object that includes the security filter that you would like to create.

-

Hierarchy

  • SecurityFilterCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: SecurityFilterCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityFilterCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: SecurityFilterCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterExclusionFilter.html b/classes/v2.SecurityFilterExclusionFilter.html index 49ea148c20b..300d767aad3 100644 --- a/classes/v2.SecurityFilterExclusionFilter.html +++ b/classes/v2.SecurityFilterExclusionFilter.html @@ -1,7 +1,7 @@ SecurityFilterExclusionFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterExclusionFilter

Exclusion filter for the security filter.

-

Hierarchy

  • SecurityFilterExclusionFilter

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string
+

Hierarchy

  • SecurityFilterExclusionFilter

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string

Exclusion filter name.

-

query

query: string
+

query

query: string

Exclusion filter query. Logs that match this query are excluded from the security filter.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterExclusionFilterResponse.html b/classes/v2.SecurityFilterExclusionFilterResponse.html index 71a4755672c..2504c0f01d7 100644 --- a/classes/v2.SecurityFilterExclusionFilterResponse.html +++ b/classes/v2.SecurityFilterExclusionFilterResponse.html @@ -1,7 +1,7 @@ SecurityFilterExclusionFilterResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterExclusionFilterResponse

A single exclusion filter.

-

Hierarchy

  • SecurityFilterExclusionFilterResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional name

name?: string
+

Hierarchy

  • SecurityFilterExclusionFilterResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional name

name?: string

The exclusion filter name.

-

Optional query

query?: string
+

Optional query

query?: string

The exclusion filter query.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterMeta.html b/classes/v2.SecurityFilterMeta.html index 052d4b2ed5d..d238ad525f9 100644 --- a/classes/v2.SecurityFilterMeta.html +++ b/classes/v2.SecurityFilterMeta.html @@ -1,5 +1,5 @@ SecurityFilterMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterMeta

Optional metadata associated to the response.

-

Hierarchy

  • SecurityFilterMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional warning

warning?: string
+

Hierarchy

  • SecurityFilterMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional warning

warning?: string

A warning message.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterResponse.html b/classes/v2.SecurityFilterResponse.html index 8ed1c44e050..25093ea511c 100644 --- a/classes/v2.SecurityFilterResponse.html +++ b/classes/v2.SecurityFilterResponse.html @@ -1,3 +1,3 @@ SecurityFilterResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterResponse

Response object which includes a single security filter.

-

Hierarchy

  • SecurityFilterResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SecurityFilter

Optional meta

meta?: SecurityFilterMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityFilterResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SecurityFilter

Optional meta

meta?: SecurityFilterMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterUpdateAttributes.html b/classes/v2.SecurityFilterUpdateAttributes.html index 9bedd8ed5b9..632a8c2f608 100644 --- a/classes/v2.SecurityFilterUpdateAttributes.html +++ b/classes/v2.SecurityFilterUpdateAttributes.html @@ -1,13 +1,13 @@ SecurityFilterUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterUpdateAttributes

The security filters properties to be updated.

-

Hierarchy

  • SecurityFilterUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional exclusionFilters

exclusionFilters?: SecurityFilterExclusionFilter[]
+

Hierarchy

  • SecurityFilterUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional exclusionFilters

exclusionFilters?: SecurityFilterExclusionFilter[]

Exclusion filters to exclude some logs from the security filter.

-

Optional filteredDataType

filteredDataType?: "logs"

Optional isEnabled

isEnabled?: boolean
+

Optional filteredDataType

filteredDataType?: "logs"

Optional isEnabled

isEnabled?: boolean

Whether the security filter is enabled.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the security filter.

-

Optional query

query?: string
+

Optional query

query?: string

The query of the security filter.

-

Optional version

version?: number
+

Optional version

version?: number

The version of the security filter to update.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterUpdateData.html b/classes/v2.SecurityFilterUpdateData.html index 99ffe66ad6d..f2339c25849 100644 --- a/classes/v2.SecurityFilterUpdateData.html +++ b/classes/v2.SecurityFilterUpdateData.html @@ -1,3 +1,3 @@ SecurityFilterUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterUpdateData

The new security filter properties.

-

Hierarchy

  • SecurityFilterUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: SecurityFilterUpdateAttributes

type

type: "security_filters"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityFilterUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: SecurityFilterUpdateAttributes

type

type: "security_filters"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFilterUpdateRequest.html b/classes/v2.SecurityFilterUpdateRequest.html index 67971fea9e5..4b437f4f53e 100644 --- a/classes/v2.SecurityFilterUpdateRequest.html +++ b/classes/v2.SecurityFilterUpdateRequest.html @@ -1,3 +1,3 @@ SecurityFilterUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFilterUpdateRequest

The new security filter body.

-

Hierarchy

  • SecurityFilterUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: SecurityFilterUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityFilterUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: SecurityFilterUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityFiltersResponse.html b/classes/v2.SecurityFiltersResponse.html index 3bf30b31d6c..94b35c89a4d 100644 --- a/classes/v2.SecurityFiltersResponse.html +++ b/classes/v2.SecurityFiltersResponse.html @@ -1,5 +1,5 @@ SecurityFiltersResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityFiltersResponse

All the available security filters objects.

-

Hierarchy

  • SecurityFiltersResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SecurityFilter[]
+

Hierarchy

  • SecurityFiltersResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SecurityFilter[]

A list of security filters objects.

-

Optional meta

meta?: SecurityFilterMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional meta

meta?: SecurityFilterMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringApi.html b/classes/v2.SecurityMonitoringApi.html index e58596676f0..be065f76ea9 100644 --- a/classes/v2.SecurityMonitoringApi.html +++ b/classes/v2.SecurityMonitoringApi.html @@ -1,46 +1,46 @@ -SecurityMonitoringApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringApi

Hierarchy

  • SecurityMonitoringApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new SecurityMonitoringApi(configuration: v2.Configuration, requestFactory?: SecurityMonitoringApiRequestFactory, responseProcessor?: SecurityMonitoringApiResponseProcessor): SecurityMonitoringApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: SecurityMonitoringApiRequestFactory

Private responseProcessor

responseProcessor: SecurityMonitoringApiResponseProcessor

Methods

createSecurityFilter

createSecurityMonitoringRule

deleteSecurityFilter

Returns Promise<SecurityMonitoringRuleResponse>

deleteSecurityFilter

deleteSecurityMonitoringRule

Returns Promise<void>

deleteSecurityMonitoringRule

getSecurityFilter

Returns Promise<void>

getSecurityFilter

getSecurityMonitoringRule

Returns Promise<SecurityFilterResponse>

getSecurityMonitoringRule

listSecurityFilters

Returns Promise<SecurityMonitoringRuleResponse>

listSecurityFilters

listSecurityMonitoringRules

listSecurityMonitoringRules

listSecurityMonitoringSignals

Returns Promise<SecurityMonitoringListRulesResponse>

listSecurityMonitoringSignals

searchSecurityMonitoringSignals

Returns Promise<SecurityMonitoringSignalsListResponse>

searchSecurityMonitoringSignals

updateSecurityFilter

Returns Promise<SecurityMonitoringSignalsListResponse>

updateSecurityFilter

updateSecurityMonitoringRule

Returns Promise<SecurityFilterResponse>

updateSecurityMonitoringRule

Optional meta

meta?: v2.ResponseMetaAttributes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleCase.html b/classes/v2.SecurityMonitoringRuleCase.html index abafbc9009e..d1557807dfc 100644 --- a/classes/v2.SecurityMonitoringRuleCase.html +++ b/classes/v2.SecurityMonitoringRuleCase.html @@ -1,9 +1,9 @@ SecurityMonitoringRuleCase | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleCase

Case when signal is generated.

-

Hierarchy

  • SecurityMonitoringRuleCase

Index

Constructors

Properties

Constructors

constructor

Properties

Optional condition

condition?: string
+

Hierarchy

  • SecurityMonitoringRuleCase

Index

Constructors

Properties

Constructors

constructor

Properties

Optional condition

condition?: string

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated based on the event counts in the previously defined queries.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the case.

-

Optional notifications

notifications?: string[]
+

Optional notifications

notifications?: string[]

Notification targets for each rule case.

-

Optional status

status?: SecurityMonitoringRuleSeverity

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: SecurityMonitoringRuleSeverity

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleCaseCreate.html b/classes/v2.SecurityMonitoringRuleCaseCreate.html index 6a2292c20b5..a618160c49b 100644 --- a/classes/v2.SecurityMonitoringRuleCaseCreate.html +++ b/classes/v2.SecurityMonitoringRuleCaseCreate.html @@ -1,9 +1,9 @@ SecurityMonitoringRuleCaseCreate | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleCaseCreate

Case when signal is generated.

-

Hierarchy

  • SecurityMonitoringRuleCaseCreate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional condition

condition?: string
+

Hierarchy

  • SecurityMonitoringRuleCaseCreate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional condition

condition?: string

A rule case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated based on the event counts in the previously defined queries.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the case.

-

Optional notifications

notifications?: string[]
+

Optional notifications

notifications?: string[]

Notification targets for each rule case.

-

status

status: SecurityMonitoringRuleSeverity

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

status

status: SecurityMonitoringRuleSeverity

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleCreatePayload.html b/classes/v2.SecurityMonitoringRuleCreatePayload.html index 150d95eda2c..e49c87adf6a 100644 --- a/classes/v2.SecurityMonitoringRuleCreatePayload.html +++ b/classes/v2.SecurityMonitoringRuleCreatePayload.html @@ -1,19 +1,19 @@ SecurityMonitoringRuleCreatePayload | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleCreatePayload

Create a new rule.

-

Hierarchy

  • SecurityMonitoringRuleCreatePayload

Index

Constructors

Properties

Constructors

constructor

Properties

cases

cases: SecurityMonitoringRuleCaseCreate[]
+

Hierarchy

  • SecurityMonitoringRuleCreatePayload

Index

Constructors

Properties

Constructors

constructor

Properties

cases

cases: SecurityMonitoringRuleCaseCreate[]

Cases for generating signals.

-

Optional filters

filters?: SecurityMonitoringFilter[]
+

Optional filters

filters?: SecurityMonitoringFilter[]

Additional queries to filter matched events before they are processed.

-

Optional hasExtendedTitle

hasExtendedTitle?: boolean
+

Optional hasExtendedTitle

hasExtendedTitle?: boolean

Whether the notifications include the triggering group-by values in their title.

-

isEnabled

isEnabled: boolean
+

isEnabled

isEnabled: boolean

Whether the rule is enabled.

-

message

message: string
+

message

message: string

Message for generated signals.

-

name

name: string
+

name

name: string

The name of the rule.

-

options

options: SecurityMonitoringRuleOptions

queries

queries: SecurityMonitoringRuleQueryCreate[]
+

options

options: SecurityMonitoringRuleOptions

queries

queries: SecurityMonitoringRuleQueryCreate[]

Queries for selecting logs which are part of the rule.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

Tags for generated signals.

-

Optional type

type?: SecurityMonitoringRuleTypeCreate

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: SecurityMonitoringRuleTypeCreate

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleNewValueOptions.html b/classes/v2.SecurityMonitoringRuleNewValueOptions.html index 12d67d1c2d1..90bc1cefb8d 100644 --- a/classes/v2.SecurityMonitoringRuleNewValueOptions.html +++ b/classes/v2.SecurityMonitoringRuleNewValueOptions.html @@ -1,3 +1,3 @@ SecurityMonitoringRuleNewValueOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleNewValueOptions

Options on new value rules.

-

Hierarchy

  • SecurityMonitoringRuleNewValueOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional forgetAfter

forgetAfter?: SecurityMonitoringRuleNewValueOptionsForgetAfter

Optional learningDuration

learningDuration?: SecurityMonitoringRuleNewValueOptionsLearningDuration

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityMonitoringRuleNewValueOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional forgetAfter

forgetAfter?: SecurityMonitoringRuleNewValueOptionsForgetAfter

Optional learningDuration

learningDuration?: SecurityMonitoringRuleNewValueOptionsLearningDuration

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleOptions.html b/classes/v2.SecurityMonitoringRuleOptions.html index a44cc9ce2d2..5fd223fc9a8 100644 --- a/classes/v2.SecurityMonitoringRuleOptions.html +++ b/classes/v2.SecurityMonitoringRuleOptions.html @@ -1,3 +1,3 @@ SecurityMonitoringRuleOptions | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleOptions

Options on rules.

-

Hierarchy

  • SecurityMonitoringRuleOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional detectionMethod

detectionMethod?: SecurityMonitoringRuleDetectionMethod

Optional evaluationWindow

evaluationWindow?: SecurityMonitoringRuleEvaluationWindow

Optional keepAlive

keepAlive?: SecurityMonitoringRuleKeepAlive

Optional maxSignalDuration

maxSignalDuration?: SecurityMonitoringRuleMaxSignalDuration

Optional newValueOptions

newValueOptions?: SecurityMonitoringRuleNewValueOptions

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityMonitoringRuleOptions

Index

Constructors

Properties

Constructors

constructor

Properties

Optional detectionMethod

detectionMethod?: SecurityMonitoringRuleDetectionMethod

Optional evaluationWindow

evaluationWindow?: SecurityMonitoringRuleEvaluationWindow

Optional keepAlive

keepAlive?: SecurityMonitoringRuleKeepAlive

Optional maxSignalDuration

maxSignalDuration?: SecurityMonitoringRuleMaxSignalDuration

Optional newValueOptions

newValueOptions?: SecurityMonitoringRuleNewValueOptions

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleQuery.html b/classes/v2.SecurityMonitoringRuleQuery.html index 9be2385fdd3..8963408a723 100644 --- a/classes/v2.SecurityMonitoringRuleQuery.html +++ b/classes/v2.SecurityMonitoringRuleQuery.html @@ -1,13 +1,13 @@ SecurityMonitoringRuleQuery | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleQuery

Query for matching rule.

-

Hierarchy

  • SecurityMonitoringRuleQuery

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: SecurityMonitoringRuleQueryAggregation

Optional distinctFields

distinctFields?: string[]
+

Hierarchy

  • SecurityMonitoringRuleQuery

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: SecurityMonitoringRuleQueryAggregation

Optional distinctFields

distinctFields?: string[]

Field for which the cardinality is measured. Sent as an array.

-

Optional groupByFields

groupByFields?: string[]
+

Optional groupByFields

groupByFields?: string[]

Fields to group by.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

The target field to aggregate over when using the sum or max aggregations.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the query.

-

Optional query

query?: string
+

Optional query

query?: string

Query to run on logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleQueryCreate.html b/classes/v2.SecurityMonitoringRuleQueryCreate.html index 2e8c7e38c97..e3cd5f93401 100644 --- a/classes/v2.SecurityMonitoringRuleQueryCreate.html +++ b/classes/v2.SecurityMonitoringRuleQueryCreate.html @@ -1,13 +1,13 @@ SecurityMonitoringRuleQueryCreate | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleQueryCreate

Query for matching rule.

-

Hierarchy

  • SecurityMonitoringRuleQueryCreate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: SecurityMonitoringRuleQueryAggregation

Optional distinctFields

distinctFields?: string[]
+

Hierarchy

  • SecurityMonitoringRuleQueryCreate

Index

Constructors

Properties

Constructors

constructor

Properties

Optional aggregation

aggregation?: SecurityMonitoringRuleQueryAggregation

Optional distinctFields

distinctFields?: string[]

Field for which the cardinality is measured. Sent as an array.

-

Optional groupByFields

groupByFields?: string[]
+

Optional groupByFields

groupByFields?: string[]

Fields to group by.

-

Optional metric

metric?: string
+

Optional metric

metric?: string

The target field to aggregate over when using the sum or max aggregations.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the query.

-

query

query: string
+

query

query: string

Query to run on logs.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleResponse.html b/classes/v2.SecurityMonitoringRuleResponse.html index 2ebd7dfafad..562c6a8962d 100644 --- a/classes/v2.SecurityMonitoringRuleResponse.html +++ b/classes/v2.SecurityMonitoringRuleResponse.html @@ -1,33 +1,33 @@ SecurityMonitoringRuleResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleResponse

Rule.

-

Hierarchy

  • SecurityMonitoringRuleResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cases

cases?: SecurityMonitoringRuleCase[]
+

Hierarchy

  • SecurityMonitoringRuleResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cases

cases?: SecurityMonitoringRuleCase[]

Cases for generating signals.

-

Optional createdAt

createdAt?: number
+

Optional createdAt

createdAt?: number

When the rule was created, timestamp in milliseconds.

-

Optional creationAuthorId

creationAuthorId?: number
+

Optional creationAuthorId

creationAuthorId?: number

User ID of the user who created the rule.

-

Optional filters

filters?: SecurityMonitoringFilter[]
+

Optional filters

filters?: SecurityMonitoringFilter[]

Additional queries to filter matched events before they are processed.

-

Optional hasExtendedTitle

hasExtendedTitle?: boolean
+

Optional hasExtendedTitle

hasExtendedTitle?: boolean

Whether the notifications include the triggering group-by values in their title.

-

Optional id

id?: string
+

Optional id

id?: string

The ID of the rule.

-

Optional isDefault

isDefault?: boolean
+

Optional isDefault

isDefault?: boolean

Whether the rule is included by default.

-

Optional isDeleted

isDeleted?: boolean
+

Optional isDeleted

isDeleted?: boolean

Whether the rule has been deleted.

-

Optional isEnabled

isEnabled?: boolean
+

Optional isEnabled

isEnabled?: boolean

Whether the rule is enabled.

-

Optional message

message?: string
+

Optional message

message?: string

Message for generated signals.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the rule.

-

Optional options

options?: SecurityMonitoringRuleOptions

Optional queries

queries?: SecurityMonitoringRuleQuery[]
+

Optional options

options?: SecurityMonitoringRuleOptions

Optional queries

queries?: SecurityMonitoringRuleQuery[]

Queries for selecting logs which are part of the rule.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

Tags for generated signals.

-

Optional type

type?: SecurityMonitoringRuleTypeRead

Optional updateAuthorId

updateAuthorId?: number
+

Optional type

type?: SecurityMonitoringRuleTypeRead

Optional updateAuthorId

updateAuthorId?: number

User ID of the user who updated the rule.

-

Optional version

version?: number
+

Optional version

version?: number

The version of the rule.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringRuleUpdatePayload.html b/classes/v2.SecurityMonitoringRuleUpdatePayload.html index d617125a179..f3b158614f7 100644 --- a/classes/v2.SecurityMonitoringRuleUpdatePayload.html +++ b/classes/v2.SecurityMonitoringRuleUpdatePayload.html @@ -1,21 +1,21 @@ SecurityMonitoringRuleUpdatePayload | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringRuleUpdatePayload

Update an existing rule.

-

Hierarchy

  • SecurityMonitoringRuleUpdatePayload

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cases

cases?: SecurityMonitoringRuleCase[]
+

Hierarchy

  • SecurityMonitoringRuleUpdatePayload

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cases

cases?: SecurityMonitoringRuleCase[]

Cases for generating signals.

-

Optional filters

filters?: SecurityMonitoringFilter[]
+

Optional filters

filters?: SecurityMonitoringFilter[]

Additional queries to filter matched events before they are processed.

-

Optional hasExtendedTitle

hasExtendedTitle?: boolean
+

Optional hasExtendedTitle

hasExtendedTitle?: boolean

Whether the notifications include the triggering group-by values in their title.

-

Optional isEnabled

isEnabled?: boolean
+

Optional isEnabled

isEnabled?: boolean

Whether the rule is enabled.

-

Optional message

message?: string
+

Optional message

message?: string

Message for generated signals.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the rule.

-

Optional options

options?: SecurityMonitoringRuleOptions

Optional queries

queries?: SecurityMonitoringRuleQuery[]
+

Optional options

options?: SecurityMonitoringRuleOptions

Optional queries

queries?: SecurityMonitoringRuleQuery[]

Queries for selecting logs which are part of the rule.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

Tags for generated signals.

-

Optional version

version?: number
+

Optional version

version?: number

The version of the rule being updated.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignal.html b/classes/v2.SecurityMonitoringSignal.html index e2d9bce4e03..42917b28e39 100644 --- a/classes/v2.SecurityMonitoringSignal.html +++ b/classes/v2.SecurityMonitoringSignal.html @@ -1,5 +1,5 @@ SecurityMonitoringSignal | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignal

Object description of a security signal.

-

Hierarchy

  • SecurityMonitoringSignal

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SecurityMonitoringSignalAttributes

Optional id

id?: string
+

Hierarchy

  • SecurityMonitoringSignal

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: SecurityMonitoringSignalAttributes

Optional id

id?: string

The unique ID of the security signal.

-

Optional type

type?: "signal"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "signal"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalAttributes.html b/classes/v2.SecurityMonitoringSignalAttributes.html index 593a3b3f503..069cb64a9bb 100644 --- a/classes/v2.SecurityMonitoringSignalAttributes.html +++ b/classes/v2.SecurityMonitoringSignalAttributes.html @@ -1,11 +1,11 @@ SecurityMonitoringSignalAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalAttributes

The object containing all signal attributes and their associated values.

-

Hierarchy

  • SecurityMonitoringSignalAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: {}
+

Hierarchy

  • SecurityMonitoringSignalAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: {}

A JSON object of attributes in the security signal.

-

Type declaration

  • [key: string]: any

Optional message

message?: string
+

Type declaration

  • [key: string]: any

Optional message

message?: string

The message in the security signal defined by the rule that generated the signal.

-

Optional tags

tags?: string[]
+

Optional tags

tags?: string[]

An array of tags associated with the security signal.

-

Optional timestamp

timestamp?: Date
+

Optional timestamp

timestamp?: Date

The timestamp of the security signal.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalListRequest.html b/classes/v2.SecurityMonitoringSignalListRequest.html index 9d4ac114032..cfa996a9fa8 100644 --- a/classes/v2.SecurityMonitoringSignalListRequest.html +++ b/classes/v2.SecurityMonitoringSignalListRequest.html @@ -1,3 +1,3 @@ SecurityMonitoringSignalListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalListRequest

The request for a security signal list.

-

Hierarchy

  • SecurityMonitoringSignalListRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: SecurityMonitoringSignalListRequestFilter

Optional page

page?: SecurityMonitoringSignalListRequestPage

Optional sort

sort?: SecurityMonitoringSignalsSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityMonitoringSignalListRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional filter

filter?: SecurityMonitoringSignalListRequestFilter

Optional page

page?: SecurityMonitoringSignalListRequestPage

Optional sort

sort?: SecurityMonitoringSignalsSort

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalListRequestFilter.html b/classes/v2.SecurityMonitoringSignalListRequestFilter.html index 7b296fc7137..541f5b07ee1 100644 --- a/classes/v2.SecurityMonitoringSignalListRequestFilter.html +++ b/classes/v2.SecurityMonitoringSignalListRequestFilter.html @@ -1,9 +1,9 @@ SecurityMonitoringSignalListRequestFilter | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalListRequestFilter

Search filters for listing security signals.

-

Hierarchy

  • SecurityMonitoringSignalListRequestFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional from

from?: Date
+

Hierarchy

  • SecurityMonitoringSignalListRequestFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional from

from?: Date

The minimum timestamp for requested security signals.

-

Optional query

query?: string
+

Optional query

query?: string

Search query for listing security signals.

-

Optional to

to?: Date
+

Optional to

to?: Date

The maximum timestamp for requested security signals.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalListRequestPage.html b/classes/v2.SecurityMonitoringSignalListRequestPage.html index 85059e6ab4a..b63d6bb16d9 100644 --- a/classes/v2.SecurityMonitoringSignalListRequestPage.html +++ b/classes/v2.SecurityMonitoringSignalListRequestPage.html @@ -1,7 +1,7 @@ SecurityMonitoringSignalListRequestPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalListRequestPage

The paging attributes for listing security signals.

-

Hierarchy

  • SecurityMonitoringSignalListRequestPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cursor

cursor?: string
+

Hierarchy

  • SecurityMonitoringSignalListRequestPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional cursor

cursor?: string

A list of results using the cursor provided in the previous query.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

The maximum number of security signals in the response.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalsListResponse.html b/classes/v2.SecurityMonitoringSignalsListResponse.html index e0058a857ba..f4cfde53996 100644 --- a/classes/v2.SecurityMonitoringSignalsListResponse.html +++ b/classes/v2.SecurityMonitoringSignalsListResponse.html @@ -1,5 +1,5 @@ SecurityMonitoringSignalsListResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalsListResponse

The response object with all security signals matching the request and pagination information.

-

Hierarchy

  • SecurityMonitoringSignalsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SecurityMonitoringSignal[]
+

Hierarchy

  • SecurityMonitoringSignalsListResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: SecurityMonitoringSignal[]

An array of security signals matching the request.

-

Optional links

links?: SecurityMonitoringSignalsListResponseLinks

Optional meta

meta?: SecurityMonitoringSignalsListResponseMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional links

links?: SecurityMonitoringSignalsListResponseLinks

Optional meta

meta?: SecurityMonitoringSignalsListResponseMeta

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalsListResponseLinks.html b/classes/v2.SecurityMonitoringSignalsListResponseLinks.html index e49b1364666..f6d707f4834 100644 --- a/classes/v2.SecurityMonitoringSignalsListResponseLinks.html +++ b/classes/v2.SecurityMonitoringSignalsListResponseLinks.html @@ -1,5 +1,5 @@ SecurityMonitoringSignalsListResponseLinks | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalsListResponseLinks

Links attributes.

-

Hierarchy

  • SecurityMonitoringSignalsListResponseLinks

Index

Constructors

Properties

Constructors

constructor

Properties

Optional next

next?: string
+

Hierarchy

  • SecurityMonitoringSignalsListResponseLinks

Index

Constructors

Properties

Constructors

constructor

Properties

Optional next

next?: string

The link for the next set of results. Note: The request can also be made using the POST endpoint.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalsListResponseMeta.html b/classes/v2.SecurityMonitoringSignalsListResponseMeta.html index b988630fe0a..c1d023498df 100644 --- a/classes/v2.SecurityMonitoringSignalsListResponseMeta.html +++ b/classes/v2.SecurityMonitoringSignalsListResponseMeta.html @@ -1,3 +1,3 @@ SecurityMonitoringSignalsListResponseMeta | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalsListResponseMeta

Meta attributes.

-

Hierarchy

  • SecurityMonitoringSignalsListResponseMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: SecurityMonitoringSignalsListResponseMetaPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SecurityMonitoringSignalsListResponseMeta

Index

Constructors

Properties

Constructors

constructor

Properties

Optional page

page?: SecurityMonitoringSignalsListResponseMetaPage

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SecurityMonitoringSignalsListResponseMetaPage.html b/classes/v2.SecurityMonitoringSignalsListResponseMetaPage.html index 05a24eda874..b4472f656e7 100644 --- a/classes/v2.SecurityMonitoringSignalsListResponseMetaPage.html +++ b/classes/v2.SecurityMonitoringSignalsListResponseMetaPage.html @@ -1,5 +1,5 @@ SecurityMonitoringSignalsListResponseMetaPage | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecurityMonitoringSignalsListResponseMetaPage

Paging attributes.

-

Hierarchy

  • SecurityMonitoringSignalsListResponseMetaPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional after

after?: string
+

Hierarchy

  • SecurityMonitoringSignalsListResponseMetaPage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional after

after?: string

The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.SelfDecodingBody.html b/classes/v2.SelfDecodingBody.html index 5f6ba576956..e4bc8632883 100644 --- a/classes/v2.SelfDecodingBody.html +++ b/classes/v2.SelfDecodingBody.html @@ -1,3 +1,3 @@ SelfDecodingBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SelfDecodingBody

Helper class to generate a ResponseBody from binary data

-

Hierarchy

  • SelfDecodingBody

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • SelfDecodingBody

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Constructor
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ServerConfiguration.html b/classes/v2.ServerConfiguration.html index 51e92e259c0..96def48716e 100644 --- a/classes/v2.ServerConfiguration.html +++ b/classes/v2.ServerConfiguration.html @@ -1,14 +1,14 @@ ServerConfiguration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerConfiguration<T>

Represents the configuration of a server including its url template and variable configuration based on the url.

-

Type parameters

  • T: {}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getConfiguration

  • getConfiguration(): {}

makeRequestContext

Type parameters

  • T: {}

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getConfiguration

  • getConfiguration(): {}

makeRequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

Returns v2.RequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

Hierarchy

  • ServiceAccountCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: ServiceAccountCreateAttributes

Optional relationships

relationships?: UserRelationships

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ServiceAccountCreateRequest.html b/classes/v2.ServiceAccountCreateRequest.html index 809177d4de0..2601a287e9f 100644 --- a/classes/v2.ServiceAccountCreateRequest.html +++ b/classes/v2.ServiceAccountCreateRequest.html @@ -1,3 +1,3 @@ ServiceAccountCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceAccountCreateRequest

Create a service account.

-

Hierarchy

  • ServiceAccountCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: ServiceAccountCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ServiceAccountCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: ServiceAccountCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.ServiceAccountsApi.html b/classes/v2.ServiceAccountsApi.html index 3c75424fda5..cc7fb7dd8f0 100644 --- a/classes/v2.ServiceAccountsApi.html +++ b/classes/v2.ServiceAccountsApi.html @@ -1,20 +1,20 @@ -ServiceAccountsApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceAccountsApi

Hierarchy

  • ServiceAccountsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ServiceAccountsApi(configuration: v2.Configuration, requestFactory?: ServiceAccountsApiRequestFactory, responseProcessor?: ServiceAccountsApiResponseProcessor): ServiceAccountsApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: ServiceAccountsApiRequestFactory

Private responseProcessor

responseProcessor: ServiceAccountsApiResponseProcessor

Methods

createServiceAccountApplicationKey

deleteServiceAccountApplicationKey

getServiceAccountApplicationKey

Returns Promise<void>

getServiceAccountApplicationKey

listServiceAccountApplicationKeys

Returns Promise<PartialApplicationKeyResponse>

listServiceAccountApplicationKeys

updateServiceAccountApplicationKey

Returns Promise<ListApplicationKeysResponse>

updateServiceAccountApplicationKey

Optional relationships

relationships?: UserResponseRelationships

Optional type

type?: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserAttributes.html b/classes/v2.UserAttributes.html index 1ebd3de27cf..effbffddd8e 100644 --- a/classes/v2.UserAttributes.html +++ b/classes/v2.UserAttributes.html @@ -1,25 +1,25 @@ UserAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserAttributes

Attributes of user object returned by the API.

-

Hierarchy

  • UserAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • UserAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the user.

-

Optional disabled

disabled?: boolean
+

Optional disabled

disabled?: boolean

Whether the user is disabled.

-

Optional email

email?: string
+

Optional email

email?: string

Email of the user.

-

Optional handle

handle?: string
+

Optional handle

handle?: string

Handle of the user.

-

Optional icon

icon?: string
+

Optional icon

icon?: string

URL of the user's icon.

-

Optional modifiedAt

modifiedAt?: Date
+

Optional modifiedAt

modifiedAt?: Date

Time that the user was last modified.

-

Optional name

name?: string
+

Optional name

name?: string

Name of the user.

-

Optional serviceAccount

serviceAccount?: boolean
+

Optional serviceAccount

serviceAccount?: boolean

Whether the user is a service account.

-

Optional status

status?: string
+

Optional status

status?: string

Status of the user.

-

Optional title

title?: string
+

Optional title

title?: string

Title of the user.

-

Optional verified

verified?: boolean
+

Optional verified

verified?: boolean

Whether the user is verified.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserCreateAttributes.html b/classes/v2.UserCreateAttributes.html index db5e7abdf68..4c778ab34a1 100644 --- a/classes/v2.UserCreateAttributes.html +++ b/classes/v2.UserCreateAttributes.html @@ -1,9 +1,9 @@ UserCreateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserCreateAttributes

Attributes of the created user.

-

Hierarchy

  • UserCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

email

email: string
+

Hierarchy

  • UserCreateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

email

email: string

The email of the user.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the user.

-

Optional title

title?: string
+

Optional title

title?: string

The title of the user.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserCreateData.html b/classes/v2.UserCreateData.html index 1cb7b202177..c11e6eea958 100644 --- a/classes/v2.UserCreateData.html +++ b/classes/v2.UserCreateData.html @@ -1,3 +1,3 @@ UserCreateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserCreateData

Object to create a user.

-

Hierarchy

  • UserCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: UserCreateAttributes

Optional relationships

relationships?: UserRelationships

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserCreateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: UserCreateAttributes

Optional relationships

relationships?: UserRelationships

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserCreateRequest.html b/classes/v2.UserCreateRequest.html index 2f29989abf9..691cdc3ede9 100644 --- a/classes/v2.UserCreateRequest.html +++ b/classes/v2.UserCreateRequest.html @@ -1,3 +1,3 @@ UserCreateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserCreateRequest

Create a user.

-

Hierarchy

  • UserCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: UserCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserCreateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: UserCreateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationData.html b/classes/v2.UserInvitationData.html index 7724f4e38d5..d1ad41c0328 100644 --- a/classes/v2.UserInvitationData.html +++ b/classes/v2.UserInvitationData.html @@ -1,3 +1,3 @@ UserInvitationData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationData

Object to create a user invitation.

-

Hierarchy

  • UserInvitationData

Index

Constructors

Properties

Constructors

constructor

Properties

relationships

relationships: UserInvitationRelationships

type

type: "user_invitations"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserInvitationData

Index

Constructors

Properties

Constructors

constructor

Properties

relationships

relationships: UserInvitationRelationships

type

type: "user_invitations"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationDataAttributes.html b/classes/v2.UserInvitationDataAttributes.html index c6dbae83797..93b5a517818 100644 --- a/classes/v2.UserInvitationDataAttributes.html +++ b/classes/v2.UserInvitationDataAttributes.html @@ -1,11 +1,11 @@ UserInvitationDataAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationDataAttributes

Attributes of a user invitation.

-

Hierarchy

  • UserInvitationDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date
+

Hierarchy

  • UserInvitationDataAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional createdAt

createdAt?: Date

Creation time of the user invitation.

-

Optional expiresAt

expiresAt?: Date
+

Optional expiresAt

expiresAt?: Date

Time of invitation expiration.

-

Optional inviteType

inviteType?: string
+

Optional inviteType

inviteType?: string

Type of invitation.

-

Optional uuid

uuid?: string
+

Optional uuid

uuid?: string

UUID of the user invitation.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationRelationships.html b/classes/v2.UserInvitationRelationships.html index 856d00332cf..d4a0446e168 100644 --- a/classes/v2.UserInvitationRelationships.html +++ b/classes/v2.UserInvitationRelationships.html @@ -1,3 +1,3 @@ UserInvitationRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationRelationships

Relationships data for user invitation.

-

Hierarchy

  • UserInvitationRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

user

user: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserInvitationRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

user

user: RelationshipToUser

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationResponse.html b/classes/v2.UserInvitationResponse.html index 5824ede7ce5..0b756724c6e 100644 --- a/classes/v2.UserInvitationResponse.html +++ b/classes/v2.UserInvitationResponse.html @@ -1,3 +1,3 @@ UserInvitationResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationResponse

User invitation as returned by the API.

-

Hierarchy

  • UserInvitationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UserInvitationResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserInvitationResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UserInvitationResponseData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationResponseData.html b/classes/v2.UserInvitationResponseData.html index 0d88116812c..e66b0dbf722 100644 --- a/classes/v2.UserInvitationResponseData.html +++ b/classes/v2.UserInvitationResponseData.html @@ -1,5 +1,5 @@ UserInvitationResponseData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationResponseData

Object of a user invitation returned by the API.

-

Hierarchy

  • UserInvitationResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: UserInvitationDataAttributes

Optional id

id?: string
+

Hierarchy

  • UserInvitationResponseData

Index

Constructors

Properties

Constructors

constructor

Properties

Optional attributes

attributes?: UserInvitationDataAttributes

Optional id

id?: string

ID of the user invitation.

-

Optional type

type?: "user_invitations"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional type

type?: "user_invitations"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationsRequest.html b/classes/v2.UserInvitationsRequest.html index 541ce7023dc..0a1b79b3dd1 100644 --- a/classes/v2.UserInvitationsRequest.html +++ b/classes/v2.UserInvitationsRequest.html @@ -1,5 +1,5 @@ UserInvitationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationsRequest

Object to invite users to join the organization.

-

Hierarchy

  • UserInvitationsRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: UserInvitationData[]
+

Hierarchy

  • UserInvitationsRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: UserInvitationData[]

List of user invitations.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserInvitationsResponse.html b/classes/v2.UserInvitationsResponse.html index ab9059c72e9..91403466d4f 100644 --- a/classes/v2.UserInvitationsResponse.html +++ b/classes/v2.UserInvitationsResponse.html @@ -1,5 +1,5 @@ UserInvitationsResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInvitationsResponse

User invitations as returned by the API.

-

Hierarchy

  • UserInvitationsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UserInvitationResponseData[]
+

Hierarchy

  • UserInvitationsResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: UserInvitationResponseData[]

Array of user invitations.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserRelationships.html b/classes/v2.UserRelationships.html index 4c3415a78d4..4b1ab3d27f1 100644 --- a/classes/v2.UserRelationships.html +++ b/classes/v2.UserRelationships.html @@ -1,3 +1,3 @@ UserRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserRelationships

Relationships of the user object.

-

Hierarchy

  • UserRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional roles

roles?: RelationshipToRoles

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional roles

roles?: RelationshipToRoles

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserResponse.html b/classes/v2.UserResponse.html index 6b1cf26db70..0e62b11c6c2 100644 --- a/classes/v2.UserResponse.html +++ b/classes/v2.UserResponse.html @@ -1,5 +1,5 @@ UserResponse | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserResponse

Response containing information about a single user.

-

Hierarchy

  • UserResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: v2.User

Optional included

included?: UserResponseIncludedItem[]
+

Hierarchy

  • UserResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional data

data?: v2.User

Optional included

included?: UserResponseIncludedItem[]

Array of objects related to the user.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserResponseRelationships.html b/classes/v2.UserResponseRelationships.html index 1bac4342fd0..0b0a47455dc 100644 --- a/classes/v2.UserResponseRelationships.html +++ b/classes/v2.UserResponseRelationships.html @@ -1,3 +1,3 @@ UserResponseRelationships | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserResponseRelationships

Relationships of the user object returned by the API.

-

Hierarchy

  • UserResponseRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional org

org?: RelationshipToOrganization

Optional otherOrgs

otherOrgs?: RelationshipToOrganizations

Optional otherUsers

otherUsers?: RelationshipToUsers

Optional roles

roles?: RelationshipToRoles

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserResponseRelationships

Index

Constructors

Properties

Constructors

constructor

Properties

Optional org

org?: RelationshipToOrganization

Optional otherOrgs

otherOrgs?: RelationshipToOrganizations

Optional otherUsers

otherUsers?: RelationshipToUsers

Optional roles

roles?: RelationshipToRoles

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserUpdateAttributes.html b/classes/v2.UserUpdateAttributes.html index 3433fd750d0..3338446f69c 100644 --- a/classes/v2.UserUpdateAttributes.html +++ b/classes/v2.UserUpdateAttributes.html @@ -1,9 +1,9 @@ UserUpdateAttributes | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserUpdateAttributes

Attributes of the edited user.

-

Hierarchy

  • UserUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional disabled

disabled?: boolean
+

Hierarchy

  • UserUpdateAttributes

Index

Constructors

Properties

Constructors

constructor

Properties

Optional disabled

disabled?: boolean

If the user is enabled or disabled.

-

Optional email

email?: string
+

Optional email

email?: string

The email of the user.

-

Optional name

name?: string
+

Optional name

name?: string

The name of the user.

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserUpdateData.html b/classes/v2.UserUpdateData.html index 5cd2ac26c6a..2ca64324a0b 100644 --- a/classes/v2.UserUpdateData.html +++ b/classes/v2.UserUpdateData.html @@ -1,5 +1,5 @@ UserUpdateData | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserUpdateData

Object to update a user.

-

Hierarchy

  • UserUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: UserUpdateAttributes

id

id: string
+

Hierarchy

  • UserUpdateData

Index

Constructors

Properties

Constructors

constructor

Properties

attributes

attributes: UserUpdateAttributes

id

id: string

ID of the user.

-

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

type

type: "users"

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UserUpdateRequest.html b/classes/v2.UserUpdateRequest.html index c8c5de51570..52af99f9b0a 100644 --- a/classes/v2.UserUpdateRequest.html +++ b/classes/v2.UserUpdateRequest.html @@ -1,3 +1,3 @@ UserUpdateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserUpdateRequest

Update a user.

-

Hierarchy

  • UserUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: UserUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • UserUpdateRequest

Index

Constructors

Properties

Constructors

constructor

Properties

data

data: UserUpdateData

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v2.UsersApi.html b/classes/v2.UsersApi.html index aeed4e9fd95..104804e565b 100644 --- a/classes/v2.UsersApi.html +++ b/classes/v2.UsersApi.html @@ -1,40 +1,40 @@ -UsersApi | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsersApi

Hierarchy

  • UsersApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new UsersApi(configuration: v2.Configuration, requestFactory?: UsersApiRequestFactory, responseProcessor?: UsersApiResponseProcessor): v2.UsersApi

Properties

Private configuration

configuration: v2.Configuration

Private requestFactory

requestFactory: UsersApiRequestFactory

Private responseProcessor

responseProcessor: UsersApiResponseProcessor

Methods

createServiceAccount

createUser

disableUser

Returns Promise<v2.UserResponse>

disableUser

getInvitation

Returns Promise<void>

getInvitation

getUser

Returns Promise<UserInvitationResponse>

getUser

listUserOrganizations

Returns Promise<v2.UserResponse>

listUserOrganizations

listUserPermissions

Returns Promise<v2.UserResponse>

listUserPermissions

listUsers

Returns Promise<PermissionsResponse>

listUsers

sendInvitations

Returns Promise<UsersResponse>

sendInvitations

updateUser

Returns Promise<UserInvitationsResponse>

updateUser

Optional meta

meta?: v2.ResponseMetaAttributes

Legend

  • Constructor
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/v1.HttpMethod.html b/enums/v1.HttpMethod.html index 0eb42c3af64..cfd25b6939f 100644 --- a/enums/v1.HttpMethod.html +++ b/enums/v1.HttpMethod.html @@ -1,3 +1,3 @@ HttpMethod | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration HttpMethod

Represents an HTTP method.

-

Index

Enumeration members

Enumeration members

CONNECT

CONNECT = "CONNECT"

DELETE

DELETE = "DELETE"

GET

GET = "GET"

HEAD

HEAD = "HEAD"

OPTIONS

OPTIONS = "OPTIONS"

PATCH

PATCH = "PATCH"

POST

POST = "POST"

PUT

PUT = "PUT"

TRACE

TRACE = "TRACE"

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration members

Enumeration members

CONNECT

CONNECT = "CONNECT"

DELETE

DELETE = "DELETE"

GET

GET = "GET"

HEAD

HEAD = "HEAD"

OPTIONS

OPTIONS = "OPTIONS"

PATCH

PATCH = "PATCH"

POST

POST = "POST"

PUT

PUT = "PUT"

TRACE

TRACE = "TRACE"

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/v2.HttpMethod.html b/enums/v2.HttpMethod.html index b31c7a799f9..97c52570115 100644 --- a/enums/v2.HttpMethod.html +++ b/enums/v2.HttpMethod.html @@ -1,3 +1,3 @@ HttpMethod | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration HttpMethod

Represents an HTTP method.

-

Index

Enumeration members

Enumeration members

CONNECT

CONNECT = "CONNECT"

DELETE

DELETE = "DELETE"

GET

GET = "GET"

HEAD

HEAD = "HEAD"

OPTIONS

OPTIONS = "OPTIONS"

PATCH

PATCH = "PATCH"

POST

POST = "POST"

PUT

PUT = "PUT"

TRACE

TRACE = "TRACE"

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration members

Enumeration members

CONNECT

CONNECT = "CONNECT"

DELETE

DELETE = "DELETE"

GET

GET = "GET"

HEAD

HEAD = "HEAD"

OPTIONS

OPTIONS = "OPTIONS"

PATCH

PATCH = "PATCH"

POST

POST = "POST"

PUT

PUT = "PUT"

TRACE

TRACE = "TRACE"

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiCreateAWSAccountRequest.html b/interfaces/v1.AWSIntegrationApiCreateAWSAccountRequest.html index be4b064ada0..abf4431fc2e 100644 --- a/interfaces/v1.AWSIntegrationApiCreateAWSAccountRequest.html +++ b/interfaces/v1.AWSIntegrationApiCreateAWSAccountRequest.html @@ -1,3 +1,3 @@ -AWSIntegrationApiCreateAWSAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiCreateAWSAccountRequest

Hierarchy

  • AWSIntegrationApiCreateAWSAccountRequest

Index

Properties

Properties

body

body: AWSAccount
+AWSIntegrationApiCreateAWSAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiCreateAWSAccountRequest

Hierarchy

  • AWSIntegrationApiCreateAWSAccountRequest

Index

Properties

Properties

body

body: AWSAccount

AWS Request Object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiCreateAWSTagFilterRequest.html b/interfaces/v1.AWSIntegrationApiCreateAWSTagFilterRequest.html index 7cb258134fc..2ca3df0aaaa 100644 --- a/interfaces/v1.AWSIntegrationApiCreateAWSTagFilterRequest.html +++ b/interfaces/v1.AWSIntegrationApiCreateAWSTagFilterRequest.html @@ -1,3 +1,3 @@ -AWSIntegrationApiCreateAWSTagFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiCreateAWSTagFilterRequest

Hierarchy

  • AWSIntegrationApiCreateAWSTagFilterRequest

Index

Properties

Properties

body

body: AWSTagFilterCreateRequest
+AWSIntegrationApiCreateAWSTagFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiCreateAWSTagFilterRequest

Hierarchy

  • AWSIntegrationApiCreateAWSTagFilterRequest

Index

Properties

Properties

body

body: AWSTagFilterCreateRequest

Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiCreateNewAWSExternalIDRequest.html b/interfaces/v1.AWSIntegrationApiCreateNewAWSExternalIDRequest.html index f8fe35871d8..586b93e8bcf 100644 --- a/interfaces/v1.AWSIntegrationApiCreateNewAWSExternalIDRequest.html +++ b/interfaces/v1.AWSIntegrationApiCreateNewAWSExternalIDRequest.html @@ -1,3 +1,3 @@ -AWSIntegrationApiCreateNewAWSExternalIDRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiCreateNewAWSExternalIDRequest

Hierarchy

  • AWSIntegrationApiCreateNewAWSExternalIDRequest

Index

Properties

Properties

body

body: AWSAccount
+AWSIntegrationApiCreateNewAWSExternalIDRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiCreateNewAWSExternalIDRequest

Hierarchy

  • AWSIntegrationApiCreateNewAWSExternalIDRequest

Index

Properties

Properties

body

body: AWSAccount

Your Datadog role delegation name. For more information about your AWS account Role name, see the Datadog AWS integration configuration info.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiDeleteAWSAccountRequest.html b/interfaces/v1.AWSIntegrationApiDeleteAWSAccountRequest.html index bd268b1fa8c..7fe00529123 100644 --- a/interfaces/v1.AWSIntegrationApiDeleteAWSAccountRequest.html +++ b/interfaces/v1.AWSIntegrationApiDeleteAWSAccountRequest.html @@ -1,3 +1,3 @@ -AWSIntegrationApiDeleteAWSAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiDeleteAWSAccountRequest

Hierarchy

  • AWSIntegrationApiDeleteAWSAccountRequest

Index

Properties

Properties

body

body: AWSAccountDeleteRequest
+AWSIntegrationApiDeleteAWSAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiDeleteAWSAccountRequest

Hierarchy

  • AWSIntegrationApiDeleteAWSAccountRequest

Index

Properties

Properties

body

body: AWSAccountDeleteRequest

AWS request object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiDeleteAWSTagFilterRequest.html b/interfaces/v1.AWSIntegrationApiDeleteAWSTagFilterRequest.html index 427ffb18961..3d1d21f2530 100644 --- a/interfaces/v1.AWSIntegrationApiDeleteAWSTagFilterRequest.html +++ b/interfaces/v1.AWSIntegrationApiDeleteAWSTagFilterRequest.html @@ -1,3 +1,3 @@ -AWSIntegrationApiDeleteAWSTagFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiDeleteAWSTagFilterRequest

Hierarchy

  • AWSIntegrationApiDeleteAWSTagFilterRequest

Index

Properties

Properties

body

body: AWSTagFilterDeleteRequest
+AWSIntegrationApiDeleteAWSTagFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiDeleteAWSTagFilterRequest

Hierarchy

  • AWSIntegrationApiDeleteAWSTagFilterRequest

Index

Properties

Properties

body

body: AWSTagFilterDeleteRequest

Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiListAWSAccountsRequest.html b/interfaces/v1.AWSIntegrationApiListAWSAccountsRequest.html index dc471c467ae..7d92f1a1c34 100644 --- a/interfaces/v1.AWSIntegrationApiListAWSAccountsRequest.html +++ b/interfaces/v1.AWSIntegrationApiListAWSAccountsRequest.html @@ -1,7 +1,7 @@ -AWSIntegrationApiListAWSAccountsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiListAWSAccountsRequest

Hierarchy

  • AWSIntegrationApiListAWSAccountsRequest

Index

Properties

Properties

Optional accessKeyId

accessKeyId?: string
+AWSIntegrationApiListAWSAccountsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiListAWSAccountsRequest

Hierarchy

  • AWSIntegrationApiListAWSAccountsRequest

Index

Properties

Properties

Optional accessKeyId

accessKeyId?: string

Only return AWS accounts that matches this `access_key_id`.

-

Optional accountId

accountId?: string
+

Optional accountId

accountId?: string

Only return AWS accounts that matches this `account_id`.

-

Optional roleName

roleName?: string
+

Optional roleName

roleName?: string

Only return AWS accounts that matches this role_name.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiListAWSTagFiltersRequest.html b/interfaces/v1.AWSIntegrationApiListAWSTagFiltersRequest.html index 00dc7f65f7b..e5955c90267 100644 --- a/interfaces/v1.AWSIntegrationApiListAWSTagFiltersRequest.html +++ b/interfaces/v1.AWSIntegrationApiListAWSTagFiltersRequest.html @@ -1,3 +1,3 @@ -AWSIntegrationApiListAWSTagFiltersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiListAWSTagFiltersRequest

Hierarchy

  • AWSIntegrationApiListAWSTagFiltersRequest

Index

Properties

Properties

accountId

accountId: string
+AWSIntegrationApiListAWSTagFiltersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiListAWSTagFiltersRequest

Hierarchy

  • AWSIntegrationApiListAWSTagFiltersRequest

Index

Properties

Properties

accountId

accountId: string

Only return AWS filters that matches this `account_id`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiUpdateAWSAccountRequest.html b/interfaces/v1.AWSIntegrationApiUpdateAWSAccountRequest.html index 376d775b6cf..006dc72365a 100644 --- a/interfaces/v1.AWSIntegrationApiUpdateAWSAccountRequest.html +++ b/interfaces/v1.AWSIntegrationApiUpdateAWSAccountRequest.html @@ -1,9 +1,9 @@ -AWSIntegrationApiUpdateAWSAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiUpdateAWSAccountRequest

Hierarchy

  • AWSIntegrationApiUpdateAWSAccountRequest

Index

Properties

Properties

Optional accessKeyId

accessKeyId?: string
+AWSIntegrationApiUpdateAWSAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSIntegrationApiUpdateAWSAccountRequest

Hierarchy

  • AWSIntegrationApiUpdateAWSAccountRequest

Index

Properties

Properties

Optional accessKeyId

accessKeyId?: string

Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified.

-

Optional accountId

accountId?: string
+

Optional accountId

accountId?: string

Only return AWS accounts that matches this `account_id`.

-

body

body: AWSAccount
+

body

body: AWSAccount

AWS request object

-

Optional roleName

roleName?: string
+

Optional roleName

roleName?: string

Only return AWS accounts that match this `role_name`. Required if `account_id` is specified.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest.html b/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest.html index 28fab50d335..53190117843 100644 --- a/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest.html +++ b/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest.html @@ -1,3 +1,3 @@ -AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest

Hierarchy

  • AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest

Index

Properties

Properties

body

body: AWSAccountAndLambdaRequest
+AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest

Hierarchy

  • AWSLogsIntegrationApiCheckAWSLogsLambdaAsyncRequest

Index

Properties

Properties

body

body: AWSAccountAndLambdaRequest

Check AWS Log Lambda Async request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest.html b/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest.html index 47dec7a5529..e9fe745d082 100644 --- a/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest.html +++ b/interfaces/v1.AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest.html @@ -1,3 +1,3 @@ -AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest

Hierarchy

  • AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest

Index

Properties

Properties

body

body: AWSLogsServicesRequest
+AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest

Hierarchy

  • AWSLogsIntegrationApiCheckAWSLogsServicesAsyncRequest

Index

Properties

Properties

body

body: AWSLogsServicesRequest

Check AWS Logs Async Services request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSLogsIntegrationApiCreateAWSLambdaARNRequest.html b/interfaces/v1.AWSLogsIntegrationApiCreateAWSLambdaARNRequest.html index 5dd4fcd0131..6de247e2848 100644 --- a/interfaces/v1.AWSLogsIntegrationApiCreateAWSLambdaARNRequest.html +++ b/interfaces/v1.AWSLogsIntegrationApiCreateAWSLambdaARNRequest.html @@ -1,3 +1,3 @@ -AWSLogsIntegrationApiCreateAWSLambdaARNRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiCreateAWSLambdaARNRequest

Hierarchy

  • AWSLogsIntegrationApiCreateAWSLambdaARNRequest

Index

Properties

Properties

body

body: AWSAccountAndLambdaRequest
+AWSLogsIntegrationApiCreateAWSLambdaARNRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiCreateAWSLambdaARNRequest

Hierarchy

  • AWSLogsIntegrationApiCreateAWSLambdaARNRequest

Index

Properties

Properties

body

body: AWSAccountAndLambdaRequest

AWS Log Lambda Async request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSLogsIntegrationApiDeleteAWSLambdaARNRequest.html b/interfaces/v1.AWSLogsIntegrationApiDeleteAWSLambdaARNRequest.html index c9b4a0d010d..9db27275c85 100644 --- a/interfaces/v1.AWSLogsIntegrationApiDeleteAWSLambdaARNRequest.html +++ b/interfaces/v1.AWSLogsIntegrationApiDeleteAWSLambdaARNRequest.html @@ -1,3 +1,3 @@ -AWSLogsIntegrationApiDeleteAWSLambdaARNRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiDeleteAWSLambdaARNRequest

Hierarchy

  • AWSLogsIntegrationApiDeleteAWSLambdaARNRequest

Index

Properties

Properties

body

body: AWSAccountAndLambdaRequest
+AWSLogsIntegrationApiDeleteAWSLambdaARNRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiDeleteAWSLambdaARNRequest

Hierarchy

  • AWSLogsIntegrationApiDeleteAWSLambdaARNRequest

Index

Properties

Properties

body

body: AWSAccountAndLambdaRequest

Delete AWS Lambda ARN request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AWSLogsIntegrationApiEnableAWSLogServicesRequest.html b/interfaces/v1.AWSLogsIntegrationApiEnableAWSLogServicesRequest.html index 2fca003d79f..0bc8ca30274 100644 --- a/interfaces/v1.AWSLogsIntegrationApiEnableAWSLogServicesRequest.html +++ b/interfaces/v1.AWSLogsIntegrationApiEnableAWSLogServicesRequest.html @@ -1,3 +1,3 @@ -AWSLogsIntegrationApiEnableAWSLogServicesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiEnableAWSLogServicesRequest

Hierarchy

  • AWSLogsIntegrationApiEnableAWSLogServicesRequest

Index

Properties

Properties

body

body: AWSLogsServicesRequest
+AWSLogsIntegrationApiEnableAWSLogServicesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AWSLogsIntegrationApiEnableAWSLogServicesRequest

Hierarchy

  • AWSLogsIntegrationApiEnableAWSLogServicesRequest

Index

Properties

Properties

body

body: AWSLogsServicesRequest

Enable AWS Log Services request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AbortSignal.html b/interfaces/v1.AbortSignal.html index 6e5f8d9f3b7..a020f82b9dd 100644 --- a/interfaces/v1.AbortSignal.html +++ b/interfaces/v1.AbortSignal.html @@ -1,3 +1,3 @@ AbortSignal | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AbortSignal

Interface for aborting fetch requests.

-

Hierarchy

  • AbortSignal

Index

Properties

Methods

Properties

aborted

aborted: boolean

onabort

onabort: null | ((event: any) => void)

Methods

addEventListener

  • addEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean; once?: boolean; passive?: boolean }): void

  • Parameters

    • type: "abort"
    • listener: (event: any) => any
        • (event: any): any

        • Parameters

          • event: any

          Returns any

    • Optional options: boolean | { capture?: boolean; once?: boolean; passive?: boolean }

    Returns void

dispatchEvent

  • dispatchEvent(event: any): boolean

removeEventListener

  • removeEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean }): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AbortSignal

Index

Properties

Methods

Properties

aborted

aborted: boolean

onabort

onabort: null | ((event: any) => void)

Methods

addEventListener

  • addEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean; once?: boolean; passive?: boolean }): void

  • Parameters

    • type: "abort"
    • listener: (event: any) => any
        • (event: any): any

        • Parameters

          • event: any

          Returns any

    • Optional options: boolean | { capture?: boolean; once?: boolean; passive?: boolean }

    Returns void

dispatchEvent

  • dispatchEvent(event: any): boolean

removeEventListener

  • removeEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean }): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AzureIntegrationApiCreateAzureIntegrationRequest.html b/interfaces/v1.AzureIntegrationApiCreateAzureIntegrationRequest.html index 1cffc7725dc..dafb3cf9358 100644 --- a/interfaces/v1.AzureIntegrationApiCreateAzureIntegrationRequest.html +++ b/interfaces/v1.AzureIntegrationApiCreateAzureIntegrationRequest.html @@ -1,3 +1,3 @@ -AzureIntegrationApiCreateAzureIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiCreateAzureIntegrationRequest

Hierarchy

  • AzureIntegrationApiCreateAzureIntegrationRequest

Index

Properties

Properties

body

body: AzureAccount
+AzureIntegrationApiCreateAzureIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiCreateAzureIntegrationRequest

Hierarchy

  • AzureIntegrationApiCreateAzureIntegrationRequest

Index

Properties

Properties

body

body: AzureAccount

Create a Datadog-Azure integration for your Datadog account request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AzureIntegrationApiDeleteAzureIntegrationRequest.html b/interfaces/v1.AzureIntegrationApiDeleteAzureIntegrationRequest.html index b5538bece99..714c560c9a4 100644 --- a/interfaces/v1.AzureIntegrationApiDeleteAzureIntegrationRequest.html +++ b/interfaces/v1.AzureIntegrationApiDeleteAzureIntegrationRequest.html @@ -1,3 +1,3 @@ -AzureIntegrationApiDeleteAzureIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiDeleteAzureIntegrationRequest

Hierarchy

  • AzureIntegrationApiDeleteAzureIntegrationRequest

Index

Properties

Properties

body

body: AzureAccount
+AzureIntegrationApiDeleteAzureIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiDeleteAzureIntegrationRequest

Hierarchy

  • AzureIntegrationApiDeleteAzureIntegrationRequest

Index

Properties

Properties

body

body: AzureAccount

Delete a given Datadog-Azure integration request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AzureIntegrationApiUpdateAzureHostFiltersRequest.html b/interfaces/v1.AzureIntegrationApiUpdateAzureHostFiltersRequest.html index 9680cc6dbe0..efb6347f828 100644 --- a/interfaces/v1.AzureIntegrationApiUpdateAzureHostFiltersRequest.html +++ b/interfaces/v1.AzureIntegrationApiUpdateAzureHostFiltersRequest.html @@ -1,3 +1,3 @@ -AzureIntegrationApiUpdateAzureHostFiltersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiUpdateAzureHostFiltersRequest

Hierarchy

  • AzureIntegrationApiUpdateAzureHostFiltersRequest

Index

Properties

Properties

body

body: AzureAccount
+AzureIntegrationApiUpdateAzureHostFiltersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiUpdateAzureHostFiltersRequest

Hierarchy

  • AzureIntegrationApiUpdateAzureHostFiltersRequest

Index

Properties

Properties

body

body: AzureAccount

Update a Datadog-Azure integration's host filters request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.AzureIntegrationApiUpdateAzureIntegrationRequest.html b/interfaces/v1.AzureIntegrationApiUpdateAzureIntegrationRequest.html index 02d6b134458..173ae571e9a 100644 --- a/interfaces/v1.AzureIntegrationApiUpdateAzureIntegrationRequest.html +++ b/interfaces/v1.AzureIntegrationApiUpdateAzureIntegrationRequest.html @@ -1,3 +1,3 @@ -AzureIntegrationApiUpdateAzureIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiUpdateAzureIntegrationRequest

Hierarchy

  • AzureIntegrationApiUpdateAzureIntegrationRequest

Index

Properties

Properties

body

body: AzureAccount
+AzureIntegrationApiUpdateAzureIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AzureIntegrationApiUpdateAzureIntegrationRequest

Hierarchy

  • AzureIntegrationApiUpdateAzureIntegrationRequest

Index

Properties

Properties

body

body: AzureAccount

Update a Datadog-Azure integration request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.Configuration.html b/interfaces/v1.Configuration.html index 894d5c0c6aa..79bc4f9a080 100644 --- a/interfaces/v1.Configuration.html +++ b/interfaces/v1.Configuration.html @@ -1 +1 @@ -Configuration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Hierarchy

  • Configuration

Index

Properties

Properties

Readonly authMethods

authMethods: v1.AuthMethods

Optional Readonly baseServer

baseServer?: v1.BaseServerConfiguration

Readonly debug

debug: undefined | boolean

Readonly httpApi

httpApi: v1.HttpLibrary

Readonly httpConfig

httpConfig: v1.HttpConfiguration

Readonly operationServerIndices

operationServerIndices: {}

Type declaration

  • [name: string]: number

Readonly serverIndex

serverIndex: number

unstableOperations

unstableOperations: {}

Type declaration

  • [name: string]: boolean

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +Configuration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Hierarchy

  • Configuration

Index

Properties

Properties

Readonly authMethods

authMethods: v1.AuthMethods

Optional Readonly baseServer

baseServer?: v1.BaseServerConfiguration

Readonly debug

debug: undefined | boolean

Readonly httpApi

httpApi: v1.HttpLibrary

Readonly httpConfig

httpConfig: v1.HttpConfiguration

Readonly operationServerIndices

operationServerIndices: {}

Type declaration

  • [name: string]: number

Readonly serverIndex

serverIndex: number

unstableOperations

unstableOperations: {}

Type declaration

  • [name: string]: boolean

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardListsApiCreateDashboardListRequest.html b/interfaces/v1.DashboardListsApiCreateDashboardListRequest.html index 947aa875734..2c04643f271 100644 --- a/interfaces/v1.DashboardListsApiCreateDashboardListRequest.html +++ b/interfaces/v1.DashboardListsApiCreateDashboardListRequest.html @@ -1,3 +1,3 @@ -DashboardListsApiCreateDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiCreateDashboardListRequest

Hierarchy

  • DashboardListsApiCreateDashboardListRequest

Index

Properties

Properties

body

body: DashboardList
+DashboardListsApiCreateDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiCreateDashboardListRequest

Hierarchy

  • DashboardListsApiCreateDashboardListRequest

Index

Properties

Properties

body

body: DashboardList

Create a dashboard list request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardListsApiDeleteDashboardListRequest.html b/interfaces/v1.DashboardListsApiDeleteDashboardListRequest.html index d5c26061db3..293099a767e 100644 --- a/interfaces/v1.DashboardListsApiDeleteDashboardListRequest.html +++ b/interfaces/v1.DashboardListsApiDeleteDashboardListRequest.html @@ -1,3 +1,3 @@ -DashboardListsApiDeleteDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiDeleteDashboardListRequest

Hierarchy

  • DashboardListsApiDeleteDashboardListRequest

Index

Properties

Properties

listId

listId: number
+DashboardListsApiDeleteDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiDeleteDashboardListRequest

Hierarchy

  • DashboardListsApiDeleteDashboardListRequest

Index

Properties

Properties

listId

listId: number

ID of the dashboard list to delete.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardListsApiGetDashboardListRequest.html b/interfaces/v1.DashboardListsApiGetDashboardListRequest.html index 5e07acd84db..b3c0b9b0870 100644 --- a/interfaces/v1.DashboardListsApiGetDashboardListRequest.html +++ b/interfaces/v1.DashboardListsApiGetDashboardListRequest.html @@ -1,3 +1,3 @@ -DashboardListsApiGetDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiGetDashboardListRequest

Hierarchy

  • DashboardListsApiGetDashboardListRequest

Index

Properties

Properties

listId

listId: number
+DashboardListsApiGetDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiGetDashboardListRequest

Hierarchy

  • DashboardListsApiGetDashboardListRequest

Index

Properties

Properties

listId

listId: number

ID of the dashboard list to fetch.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardListsApiUpdateDashboardListRequest.html b/interfaces/v1.DashboardListsApiUpdateDashboardListRequest.html index 021d0493ed9..6e9505a8ce0 100644 --- a/interfaces/v1.DashboardListsApiUpdateDashboardListRequest.html +++ b/interfaces/v1.DashboardListsApiUpdateDashboardListRequest.html @@ -1,5 +1,5 @@ -DashboardListsApiUpdateDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiUpdateDashboardListRequest

Hierarchy

  • DashboardListsApiUpdateDashboardListRequest

Index

Properties

Properties

body

body: DashboardList
+DashboardListsApiUpdateDashboardListRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiUpdateDashboardListRequest

Hierarchy

  • DashboardListsApiUpdateDashboardListRequest

Index

Properties

Properties

body

body: DashboardList

Update a dashboard list request body.

-

listId

listId: number
+

listId

listId: number

ID of the dashboard list to update.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiCreateDashboardRequest.html b/interfaces/v1.DashboardsApiCreateDashboardRequest.html index 428d75a98f4..ee43952fa5e 100644 --- a/interfaces/v1.DashboardsApiCreateDashboardRequest.html +++ b/interfaces/v1.DashboardsApiCreateDashboardRequest.html @@ -1,3 +1,3 @@ -DashboardsApiCreateDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiCreateDashboardRequest

Hierarchy

  • DashboardsApiCreateDashboardRequest

Index

Properties

Properties

body

body: Dashboard
+DashboardsApiCreateDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiCreateDashboardRequest

Hierarchy

  • DashboardsApiCreateDashboardRequest

Index

Properties

Properties

body

body: Dashboard

Create a dashboard request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiDeleteDashboardRequest.html b/interfaces/v1.DashboardsApiDeleteDashboardRequest.html index 28953be55be..04692066d81 100644 --- a/interfaces/v1.DashboardsApiDeleteDashboardRequest.html +++ b/interfaces/v1.DashboardsApiDeleteDashboardRequest.html @@ -1,3 +1,3 @@ -DashboardsApiDeleteDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiDeleteDashboardRequest

Hierarchy

  • DashboardsApiDeleteDashboardRequest

Index

Properties

Properties

dashboardId

dashboardId: string
+DashboardsApiDeleteDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiDeleteDashboardRequest

Hierarchy

  • DashboardsApiDeleteDashboardRequest

Index

Properties

Properties

dashboardId

dashboardId: string

The ID of the dashboard.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiDeleteDashboardsRequest.html b/interfaces/v1.DashboardsApiDeleteDashboardsRequest.html index d04b9ca3247..1a5bb5c643a 100644 --- a/interfaces/v1.DashboardsApiDeleteDashboardsRequest.html +++ b/interfaces/v1.DashboardsApiDeleteDashboardsRequest.html @@ -1,3 +1,3 @@ -DashboardsApiDeleteDashboardsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiDeleteDashboardsRequest

Hierarchy

  • DashboardsApiDeleteDashboardsRequest

Index

Properties

Properties

body

body: DashboardBulkDeleteRequest
+DashboardsApiDeleteDashboardsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiDeleteDashboardsRequest

Hierarchy

  • DashboardsApiDeleteDashboardsRequest

Index

Properties

Properties

body

body: DashboardBulkDeleteRequest

Delete dashboards request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiGetDashboardRequest.html b/interfaces/v1.DashboardsApiGetDashboardRequest.html index 752c014ec6f..025b5c66df9 100644 --- a/interfaces/v1.DashboardsApiGetDashboardRequest.html +++ b/interfaces/v1.DashboardsApiGetDashboardRequest.html @@ -1,3 +1,3 @@ -DashboardsApiGetDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiGetDashboardRequest

Hierarchy

  • DashboardsApiGetDashboardRequest

Index

Properties

Properties

dashboardId

dashboardId: string
+DashboardsApiGetDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiGetDashboardRequest

Hierarchy

  • DashboardsApiGetDashboardRequest

Index

Properties

Properties

dashboardId

dashboardId: string

The ID of the dashboard.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiListDashboardsRequest.html b/interfaces/v1.DashboardsApiListDashboardsRequest.html index 56a897c4f26..cf4332d2b41 100644 --- a/interfaces/v1.DashboardsApiListDashboardsRequest.html +++ b/interfaces/v1.DashboardsApiListDashboardsRequest.html @@ -1,5 +1,5 @@ -DashboardsApiListDashboardsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiListDashboardsRequest

Hierarchy

  • DashboardsApiListDashboardsRequest

Index

Properties

Properties

Optional filterDeleted

filterDeleted?: boolean
+DashboardsApiListDashboardsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiListDashboardsRequest

Hierarchy

  • DashboardsApiListDashboardsRequest

Index

Properties

Properties

Optional filterDeleted

filterDeleted?: boolean

When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`.

-

Optional filterShared

filterShared?: boolean
+

Optional filterShared

filterShared?: boolean

When `true`, this query only returns shared custom created or cloned dashboards.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiRestoreDashboardsRequest.html b/interfaces/v1.DashboardsApiRestoreDashboardsRequest.html index 77b764a59db..64cc7205c79 100644 --- a/interfaces/v1.DashboardsApiRestoreDashboardsRequest.html +++ b/interfaces/v1.DashboardsApiRestoreDashboardsRequest.html @@ -1,3 +1,3 @@ -DashboardsApiRestoreDashboardsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiRestoreDashboardsRequest

Hierarchy

  • DashboardsApiRestoreDashboardsRequest

Index

Properties

Properties

body

body: DashboardRestoreRequest
+DashboardsApiRestoreDashboardsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiRestoreDashboardsRequest

Hierarchy

  • DashboardsApiRestoreDashboardsRequest

Index

Properties

Properties

body

body: DashboardRestoreRequest

Restore dashboards request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DashboardsApiUpdateDashboardRequest.html b/interfaces/v1.DashboardsApiUpdateDashboardRequest.html index 0e0644e2ab5..1f807956338 100644 --- a/interfaces/v1.DashboardsApiUpdateDashboardRequest.html +++ b/interfaces/v1.DashboardsApiUpdateDashboardRequest.html @@ -1,5 +1,5 @@ -DashboardsApiUpdateDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiUpdateDashboardRequest

Hierarchy

  • DashboardsApiUpdateDashboardRequest

Index

Properties

Properties

body

body: Dashboard
+DashboardsApiUpdateDashboardRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardsApiUpdateDashboardRequest

Hierarchy

  • DashboardsApiUpdateDashboardRequest

Index

Properties

Properties

body

body: Dashboard

Update Dashboard request body.

-

dashboardId

dashboardId: string
+

dashboardId

dashboardId: string

The ID of the dashboard.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiCancelDowntimeRequest.html b/interfaces/v1.DowntimesApiCancelDowntimeRequest.html index 501a06c4dd1..82fb7b18e0f 100644 --- a/interfaces/v1.DowntimesApiCancelDowntimeRequest.html +++ b/interfaces/v1.DowntimesApiCancelDowntimeRequest.html @@ -1,3 +1,3 @@ -DowntimesApiCancelDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiCancelDowntimeRequest

Hierarchy

  • DowntimesApiCancelDowntimeRequest

Index

Properties

Properties

downtimeId

downtimeId: number
+DowntimesApiCancelDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiCancelDowntimeRequest

Hierarchy

  • DowntimesApiCancelDowntimeRequest

Index

Properties

Properties

downtimeId

downtimeId: number

ID of the downtime to cancel.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiCancelDowntimesByScopeRequest.html b/interfaces/v1.DowntimesApiCancelDowntimesByScopeRequest.html index b5ed401fa08..42e72c55b4c 100644 --- a/interfaces/v1.DowntimesApiCancelDowntimesByScopeRequest.html +++ b/interfaces/v1.DowntimesApiCancelDowntimesByScopeRequest.html @@ -1,3 +1,3 @@ -DowntimesApiCancelDowntimesByScopeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiCancelDowntimesByScopeRequest

Hierarchy

  • DowntimesApiCancelDowntimesByScopeRequest

Index

Properties

Properties

body

body: CancelDowntimesByScopeRequest
+DowntimesApiCancelDowntimesByScopeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiCancelDowntimesByScopeRequest

Hierarchy

  • DowntimesApiCancelDowntimesByScopeRequest

Index

Properties

Properties

body

body: CancelDowntimesByScopeRequest

Scope to cancel downtimes for.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiCreateDowntimeRequest.html b/interfaces/v1.DowntimesApiCreateDowntimeRequest.html index fb166d2c715..bd6d2098927 100644 --- a/interfaces/v1.DowntimesApiCreateDowntimeRequest.html +++ b/interfaces/v1.DowntimesApiCreateDowntimeRequest.html @@ -1,3 +1,3 @@ -DowntimesApiCreateDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiCreateDowntimeRequest

Hierarchy

  • DowntimesApiCreateDowntimeRequest

Index

Properties

Properties

body

body: Downtime
+DowntimesApiCreateDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiCreateDowntimeRequest

Hierarchy

  • DowntimesApiCreateDowntimeRequest

Index

Properties

Properties

body

body: Downtime

Schedule a downtime request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiGetDowntimeRequest.html b/interfaces/v1.DowntimesApiGetDowntimeRequest.html index 547281caf0b..8bb82f9d23d 100644 --- a/interfaces/v1.DowntimesApiGetDowntimeRequest.html +++ b/interfaces/v1.DowntimesApiGetDowntimeRequest.html @@ -1,3 +1,3 @@ -DowntimesApiGetDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiGetDowntimeRequest

Hierarchy

  • DowntimesApiGetDowntimeRequest

Index

Properties

Properties

downtimeId

downtimeId: number
+DowntimesApiGetDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiGetDowntimeRequest

Hierarchy

  • DowntimesApiGetDowntimeRequest

Index

Properties

Properties

downtimeId

downtimeId: number

ID of the downtime to fetch.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiListDowntimesRequest.html b/interfaces/v1.DowntimesApiListDowntimesRequest.html index 660d645169b..b725017d271 100644 --- a/interfaces/v1.DowntimesApiListDowntimesRequest.html +++ b/interfaces/v1.DowntimesApiListDowntimesRequest.html @@ -1,3 +1,3 @@ -DowntimesApiListDowntimesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiListDowntimesRequest

Hierarchy

  • DowntimesApiListDowntimesRequest

Index

Properties

Properties

Optional currentOnly

currentOnly?: boolean
+DowntimesApiListDowntimesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiListDowntimesRequest

Hierarchy

  • DowntimesApiListDowntimesRequest

Index

Properties

Properties

Optional currentOnly

currentOnly?: boolean

Only return downtimes that are active when the request is made.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiListMonitorDowntimesRequest.html b/interfaces/v1.DowntimesApiListMonitorDowntimesRequest.html index e8dc27ff0a7..a9764b6bb77 100644 --- a/interfaces/v1.DowntimesApiListMonitorDowntimesRequest.html +++ b/interfaces/v1.DowntimesApiListMonitorDowntimesRequest.html @@ -1,3 +1,3 @@ -DowntimesApiListMonitorDowntimesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiListMonitorDowntimesRequest

Hierarchy

  • DowntimesApiListMonitorDowntimesRequest

Index

Properties

Properties

monitorId

monitorId: number
+DowntimesApiListMonitorDowntimesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiListMonitorDowntimesRequest

Hierarchy

  • DowntimesApiListMonitorDowntimesRequest

Index

Properties

Properties

monitorId

monitorId: number

The id of the monitor

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.DowntimesApiUpdateDowntimeRequest.html b/interfaces/v1.DowntimesApiUpdateDowntimeRequest.html index 4e68cd1c684..c8367aa131a 100644 --- a/interfaces/v1.DowntimesApiUpdateDowntimeRequest.html +++ b/interfaces/v1.DowntimesApiUpdateDowntimeRequest.html @@ -1,5 +1,5 @@ -DowntimesApiUpdateDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiUpdateDowntimeRequest

Hierarchy

  • DowntimesApiUpdateDowntimeRequest

Index

Properties

Properties

body

body: Downtime
+DowntimesApiUpdateDowntimeRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DowntimesApiUpdateDowntimeRequest

Hierarchy

  • DowntimesApiUpdateDowntimeRequest

Index

Properties

Properties

body

body: Downtime

Update a downtime request body.

-

downtimeId

downtimeId: number
+

downtimeId

downtimeId: number

ID of the downtime to update.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.EventsApiCreateEventRequest.html b/interfaces/v1.EventsApiCreateEventRequest.html index 2bd5710bd6e..b64fcba8c12 100644 --- a/interfaces/v1.EventsApiCreateEventRequest.html +++ b/interfaces/v1.EventsApiCreateEventRequest.html @@ -1,3 +1,3 @@ -EventsApiCreateEventRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsApiCreateEventRequest

Hierarchy

  • EventsApiCreateEventRequest

Index

Properties

Properties

body

body: EventCreateRequest
+EventsApiCreateEventRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsApiCreateEventRequest

Hierarchy

  • EventsApiCreateEventRequest

Index

Properties

Properties

body

body: EventCreateRequest

Event request object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.EventsApiGetEventRequest.html b/interfaces/v1.EventsApiGetEventRequest.html index 70cb073e241..1d1d926901a 100644 --- a/interfaces/v1.EventsApiGetEventRequest.html +++ b/interfaces/v1.EventsApiGetEventRequest.html @@ -1,3 +1,3 @@ -EventsApiGetEventRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsApiGetEventRequest

Hierarchy

  • EventsApiGetEventRequest

Index

Properties

Properties

eventId

eventId: number
+EventsApiGetEventRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsApiGetEventRequest

Hierarchy

  • EventsApiGetEventRequest

Index

Properties

Properties

eventId

eventId: number

The ID of the event.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.EventsApiListEventsRequest.html b/interfaces/v1.EventsApiListEventsRequest.html index 9a9281738cc..5d83ebed6ad 100644 --- a/interfaces/v1.EventsApiListEventsRequest.html +++ b/interfaces/v1.EventsApiListEventsRequest.html @@ -1,17 +1,17 @@ -EventsApiListEventsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsApiListEventsRequest

Hierarchy

  • EventsApiListEventsRequest

Index

Properties

Properties

end

end: number
+EventsApiListEventsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsApiListEventsRequest

Hierarchy

  • EventsApiListEventsRequest

Index

Properties

Properties

end

end: number

POSIX timestamp.

-

Optional excludeAggregate

excludeAggregate?: boolean
+

Optional excludeAggregate

excludeAggregate?: boolean

Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default.

-

Optional page

page?: number
+

Optional page

page?: number

By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.`

-

Optional priority

priority?: EventPriority
+

Optional priority

priority?: EventPriority

Priority of your events, either `low` or `normal`.

-

Optional sources

sources?: string
+

Optional sources

sources?: string

A comma separated string of sources.

-

start

start: number
+

start

start: number

POSIX timestamp.

-

Optional tags

tags?: string
+

Optional tags

tags?: string

A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.

-

Optional unaggregated

unaggregated?: boolean
+

Optional unaggregated

unaggregated?: boolean

Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.GCPIntegrationApiCreateGCPIntegrationRequest.html b/interfaces/v1.GCPIntegrationApiCreateGCPIntegrationRequest.html index 982caa9ef93..d03089c20dc 100644 --- a/interfaces/v1.GCPIntegrationApiCreateGCPIntegrationRequest.html +++ b/interfaces/v1.GCPIntegrationApiCreateGCPIntegrationRequest.html @@ -1,3 +1,3 @@ -GCPIntegrationApiCreateGCPIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GCPIntegrationApiCreateGCPIntegrationRequest

Hierarchy

  • GCPIntegrationApiCreateGCPIntegrationRequest

Index

Properties

Properties

body

body: GCPAccount
+GCPIntegrationApiCreateGCPIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GCPIntegrationApiCreateGCPIntegrationRequest

Hierarchy

  • GCPIntegrationApiCreateGCPIntegrationRequest

Index

Properties

Properties

body

body: GCPAccount

Create a Datadog-GCP integration.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.GCPIntegrationApiDeleteGCPIntegrationRequest.html b/interfaces/v1.GCPIntegrationApiDeleteGCPIntegrationRequest.html index 96c0a1a931b..2f3803b53c3 100644 --- a/interfaces/v1.GCPIntegrationApiDeleteGCPIntegrationRequest.html +++ b/interfaces/v1.GCPIntegrationApiDeleteGCPIntegrationRequest.html @@ -1,3 +1,3 @@ -GCPIntegrationApiDeleteGCPIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GCPIntegrationApiDeleteGCPIntegrationRequest

Hierarchy

  • GCPIntegrationApiDeleteGCPIntegrationRequest

Index

Properties

Properties

body

body: GCPAccount
+GCPIntegrationApiDeleteGCPIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GCPIntegrationApiDeleteGCPIntegrationRequest

Hierarchy

  • GCPIntegrationApiDeleteGCPIntegrationRequest

Index

Properties

Properties

body

body: GCPAccount

Delete a given Datadog-GCP integration.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.GCPIntegrationApiUpdateGCPIntegrationRequest.html b/interfaces/v1.GCPIntegrationApiUpdateGCPIntegrationRequest.html index b6db5fd4773..c7023e33438 100644 --- a/interfaces/v1.GCPIntegrationApiUpdateGCPIntegrationRequest.html +++ b/interfaces/v1.GCPIntegrationApiUpdateGCPIntegrationRequest.html @@ -1,3 +1,3 @@ -GCPIntegrationApiUpdateGCPIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GCPIntegrationApiUpdateGCPIntegrationRequest

Hierarchy

  • GCPIntegrationApiUpdateGCPIntegrationRequest

Index

Properties

Properties

body

body: GCPAccount
+GCPIntegrationApiUpdateGCPIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GCPIntegrationApiUpdateGCPIntegrationRequest

Hierarchy

  • GCPIntegrationApiUpdateGCPIntegrationRequest

Index

Properties

Properties

body

body: GCPAccount

Update a Datadog-GCP integration.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.HostsApiGetHostTotalsRequest.html b/interfaces/v1.HostsApiGetHostTotalsRequest.html index 282ee2045aa..ef0dc30889b 100644 --- a/interfaces/v1.HostsApiGetHostTotalsRequest.html +++ b/interfaces/v1.HostsApiGetHostTotalsRequest.html @@ -1,3 +1,3 @@ -HostsApiGetHostTotalsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiGetHostTotalsRequest

Hierarchy

  • HostsApiGetHostTotalsRequest

Index

Properties

Properties

Optional from

from?: number
+HostsApiGetHostTotalsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiGetHostTotalsRequest

Hierarchy

  • HostsApiGetHostTotalsRequest

Index

Properties

Properties

Optional from

from?: number

Number of seconds from which you want to get total number of active hosts.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.HostsApiListHostsRequest.html b/interfaces/v1.HostsApiListHostsRequest.html index e76ccccaea3..0c5067d5c5a 100644 --- a/interfaces/v1.HostsApiListHostsRequest.html +++ b/interfaces/v1.HostsApiListHostsRequest.html @@ -1,17 +1,17 @@ -HostsApiListHostsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiListHostsRequest

Hierarchy

  • HostsApiListHostsRequest

Index

Properties

Properties

Optional count

count?: number
+HostsApiListHostsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiListHostsRequest

Hierarchy

  • HostsApiListHostsRequest

Index

Properties

Properties

Optional count

count?: number

Number of hosts to return. Max 1000.

-

Optional filter

filter?: string
+

Optional filter

filter?: string

String to filter search results.

-

Optional from

from?: number
+

Optional from

from?: number

Number of seconds since UNIX epoch from which you want to search your hosts.

-

Optional includeHostsMetadata

includeHostsMetadata?: boolean
+

Optional includeHostsMetadata

includeHostsMetadata?: boolean

Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).

-

Optional includeMutedHostsData

includeMutedHostsData?: boolean
+

Optional includeMutedHostsData

includeMutedHostsData?: boolean

Include information on the muted status of hosts and when the mute expires.

-

Optional sortDir

sortDir?: string
+

Optional sortDir

sortDir?: string

Direction of sort. Options include `asc` and `desc`.

-

Optional sortField

sortField?: string
+

Optional sortField

sortField?: string

Sort hosts by this field.

-

Optional start

start?: number
+

Optional start

start?: number

Host result to start search from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.HostsApiMuteHostRequest.html b/interfaces/v1.HostsApiMuteHostRequest.html index 4e1631c1a28..a4b8871f2ec 100644 --- a/interfaces/v1.HostsApiMuteHostRequest.html +++ b/interfaces/v1.HostsApiMuteHostRequest.html @@ -1,5 +1,5 @@ -HostsApiMuteHostRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiMuteHostRequest

Hierarchy

  • HostsApiMuteHostRequest

Index

Properties

Properties

body

body: HostMuteSettings
+HostsApiMuteHostRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiMuteHostRequest

Hierarchy

  • HostsApiMuteHostRequest

Index

Properties

Properties

body

body: HostMuteSettings

Mute a host request body.

-

hostName

hostName: string
+

hostName

hostName: string

Name of the host to mute.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.HostsApiUnmuteHostRequest.html b/interfaces/v1.HostsApiUnmuteHostRequest.html index 1d8e7607598..e8af05b3d67 100644 --- a/interfaces/v1.HostsApiUnmuteHostRequest.html +++ b/interfaces/v1.HostsApiUnmuteHostRequest.html @@ -1,3 +1,3 @@ -HostsApiUnmuteHostRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiUnmuteHostRequest

Hierarchy

  • HostsApiUnmuteHostRequest

Index

Properties

Properties

hostName

hostName: string
+HostsApiUnmuteHostRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HostsApiUnmuteHostRequest

Hierarchy

  • HostsApiUnmuteHostRequest

Index

Properties

Properties

hostName

hostName: string

Name of the host to unmute.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.HttpConfiguration.html b/interfaces/v1.HttpConfiguration.html index 9d0370d5ce7..8a6b9cb08ce 100644 --- a/interfaces/v1.HttpConfiguration.html +++ b/interfaces/v1.HttpConfiguration.html @@ -1,3 +1,3 @@ HttpConfiguration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpConfiguration

Represents an HTTP transport configuration.

-

Hierarchy

  • HttpConfiguration

Index

Properties

Properties

Optional compress

compress?: boolean

Optional signal

signal?: v1.AbortSignal

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • HttpConfiguration

Index

Properties

Properties

Optional compress

compress?: boolean

Optional signal

signal?: v1.AbortSignal

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.HttpLibrary.html b/interfaces/v1.HttpLibrary.html index d8736b0f2b5..87434e92e7d 100644 --- a/interfaces/v1.HttpLibrary.html +++ b/interfaces/v1.HttpLibrary.html @@ -1 +1 @@ -HttpLibrary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpLibrary

Hierarchy

  • HttpLibrary

Implemented by

Index

Properties

Methods

Properties

Optional debug

debug?: boolean

Methods

send

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +HttpLibrary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpLibrary

Hierarchy

  • HttpLibrary

Implemented by

Index

Properties

Methods

Properties

Optional debug

debug?: boolean

Methods

send

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiCreateAPIKeyRequest.html b/interfaces/v1.KeyManagementApiCreateAPIKeyRequest.html index cc30e444a04..66f46174f9e 100644 --- a/interfaces/v1.KeyManagementApiCreateAPIKeyRequest.html +++ b/interfaces/v1.KeyManagementApiCreateAPIKeyRequest.html @@ -1 +1 @@ -KeyManagementApiCreateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateAPIKeyRequest

Hierarchy

  • KeyManagementApiCreateAPIKeyRequest

Index

Properties

Properties

body

body: ApiKey

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +KeyManagementApiCreateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateAPIKeyRequest

Hierarchy

  • KeyManagementApiCreateAPIKeyRequest

Index

Properties

Properties

body

body: ApiKey

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiCreateApplicationKeyRequest.html b/interfaces/v1.KeyManagementApiCreateApplicationKeyRequest.html index 88c0d9b53da..cbe9cec9e21 100644 --- a/interfaces/v1.KeyManagementApiCreateApplicationKeyRequest.html +++ b/interfaces/v1.KeyManagementApiCreateApplicationKeyRequest.html @@ -1 +1 @@ -KeyManagementApiCreateApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateApplicationKeyRequest

Hierarchy

  • KeyManagementApiCreateApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKey

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +KeyManagementApiCreateApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateApplicationKeyRequest

Hierarchy

  • KeyManagementApiCreateApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKey

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiDeleteAPIKeyRequest.html b/interfaces/v1.KeyManagementApiDeleteAPIKeyRequest.html index c8550f3d1ac..ed0f41ff58c 100644 --- a/interfaces/v1.KeyManagementApiDeleteAPIKeyRequest.html +++ b/interfaces/v1.KeyManagementApiDeleteAPIKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiDeleteAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteAPIKeyRequest

Hierarchy

  • KeyManagementApiDeleteAPIKeyRequest

Index

Properties

Properties

key

key: string
+KeyManagementApiDeleteAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteAPIKeyRequest

Hierarchy

  • KeyManagementApiDeleteAPIKeyRequest

Index

Properties

Properties

key

key: string

The specific API key you are working with.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiDeleteApplicationKeyRequest.html b/interfaces/v1.KeyManagementApiDeleteApplicationKeyRequest.html index 92425fdd8d0..a61f3fdff9a 100644 --- a/interfaces/v1.KeyManagementApiDeleteApplicationKeyRequest.html +++ b/interfaces/v1.KeyManagementApiDeleteApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiDeleteApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteApplicationKeyRequest

Hierarchy

  • KeyManagementApiDeleteApplicationKeyRequest

Index

Properties

Properties

key

key: string
+KeyManagementApiDeleteApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteApplicationKeyRequest

Hierarchy

  • KeyManagementApiDeleteApplicationKeyRequest

Index

Properties

Properties

key

key: string

The specific APP key you are working with.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiGetAPIKeyRequest.html b/interfaces/v1.KeyManagementApiGetAPIKeyRequest.html index af4c40374be..3b040399045 100644 --- a/interfaces/v1.KeyManagementApiGetAPIKeyRequest.html +++ b/interfaces/v1.KeyManagementApiGetAPIKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiGetAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetAPIKeyRequest

Hierarchy

  • KeyManagementApiGetAPIKeyRequest

Index

Properties

Properties

key

key: string
+KeyManagementApiGetAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetAPIKeyRequest

Hierarchy

  • KeyManagementApiGetAPIKeyRequest

Index

Properties

Properties

key

key: string

The specific API key you are working with.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiGetApplicationKeyRequest.html b/interfaces/v1.KeyManagementApiGetApplicationKeyRequest.html index 98db79ecd8a..d1d22805834 100644 --- a/interfaces/v1.KeyManagementApiGetApplicationKeyRequest.html +++ b/interfaces/v1.KeyManagementApiGetApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiGetApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetApplicationKeyRequest

Hierarchy

  • KeyManagementApiGetApplicationKeyRequest

Index

Properties

Properties

key

key: string
+KeyManagementApiGetApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetApplicationKeyRequest

Hierarchy

  • KeyManagementApiGetApplicationKeyRequest

Index

Properties

Properties

key

key: string

The specific APP key you are working with.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiUpdateAPIKeyRequest.html b/interfaces/v1.KeyManagementApiUpdateAPIKeyRequest.html index 49a3af28554..ab90c4fe5a1 100644 --- a/interfaces/v1.KeyManagementApiUpdateAPIKeyRequest.html +++ b/interfaces/v1.KeyManagementApiUpdateAPIKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiUpdateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateAPIKeyRequest

Hierarchy

  • KeyManagementApiUpdateAPIKeyRequest

Index

Properties

Properties

body

body: ApiKey

key

key: string
+KeyManagementApiUpdateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateAPIKeyRequest

Hierarchy

  • KeyManagementApiUpdateAPIKeyRequest

Index

Properties

Properties

body

body: ApiKey

key

key: string

The specific API key you are working with.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.KeyManagementApiUpdateApplicationKeyRequest.html b/interfaces/v1.KeyManagementApiUpdateApplicationKeyRequest.html index 2d55e6c53d5..852b1319e39 100644 --- a/interfaces/v1.KeyManagementApiUpdateApplicationKeyRequest.html +++ b/interfaces/v1.KeyManagementApiUpdateApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiUpdateApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateApplicationKeyRequest

Hierarchy

  • KeyManagementApiUpdateApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKey

key

key: string
+KeyManagementApiUpdateApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateApplicationKeyRequest

Hierarchy

  • KeyManagementApiUpdateApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKey

key

key: string

The specific APP key you are working with.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsApiListLogsRequest.html b/interfaces/v1.LogsApiListLogsRequest.html index 9163da977c6..85e6f16ab80 100644 --- a/interfaces/v1.LogsApiListLogsRequest.html +++ b/interfaces/v1.LogsApiListLogsRequest.html @@ -1,3 +1,3 @@ -LogsApiListLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiListLogsRequest

Hierarchy

  • LogsApiListLogsRequest

Index

Properties

Properties

body

body: v1.LogsListRequest
+LogsApiListLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiListLogsRequest

Hierarchy

  • LogsApiListLogsRequest

Index

Properties

Properties

body

body: v1.LogsListRequest

Logs filter

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsApiSubmitLogRequest.html b/interfaces/v1.LogsApiSubmitLogRequest.html index 466b37e4945..7200a38a961 100644 --- a/interfaces/v1.LogsApiSubmitLogRequest.html +++ b/interfaces/v1.LogsApiSubmitLogRequest.html @@ -1,7 +1,7 @@ -LogsApiSubmitLogRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiSubmitLogRequest

Hierarchy

  • LogsApiSubmitLogRequest

Index

Properties

Properties

body

body: v1.HTTPLogItem[]
+LogsApiSubmitLogRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiSubmitLogRequest

Hierarchy

  • LogsApiSubmitLogRequest

Index

Properties

Properties

body

body: v1.HTTPLogItem[]

Log to send (JSON format).

-

Optional contentEncoding

contentEncoding?: v1.ContentEncoding
+

Optional contentEncoding

contentEncoding?: v1.ContentEncoding

HTTP header used to compress the media-type.

-

Optional ddtags

ddtags?: string
+

Optional ddtags

ddtags?: string

Log tags can be passed as query parameters with `text/plain` content type.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsIndexesApiCreateLogsIndexRequest.html b/interfaces/v1.LogsIndexesApiCreateLogsIndexRequest.html index 6fb301a74d0..729fd10629c 100644 --- a/interfaces/v1.LogsIndexesApiCreateLogsIndexRequest.html +++ b/interfaces/v1.LogsIndexesApiCreateLogsIndexRequest.html @@ -1,3 +1,3 @@ -LogsIndexesApiCreateLogsIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiCreateLogsIndexRequest

Hierarchy

  • LogsIndexesApiCreateLogsIndexRequest

Index

Properties

Properties

body

body: LogsIndex
+LogsIndexesApiCreateLogsIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiCreateLogsIndexRequest

Hierarchy

  • LogsIndexesApiCreateLogsIndexRequest

Index

Properties

Properties

body

body: LogsIndex

Object containing the new index.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsIndexesApiGetLogsIndexRequest.html b/interfaces/v1.LogsIndexesApiGetLogsIndexRequest.html index 3b6662cbc11..fe9ca5f4dc4 100644 --- a/interfaces/v1.LogsIndexesApiGetLogsIndexRequest.html +++ b/interfaces/v1.LogsIndexesApiGetLogsIndexRequest.html @@ -1,3 +1,3 @@ -LogsIndexesApiGetLogsIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiGetLogsIndexRequest

Hierarchy

  • LogsIndexesApiGetLogsIndexRequest

Index

Properties

Properties

name

name: string
+LogsIndexesApiGetLogsIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiGetLogsIndexRequest

Hierarchy

  • LogsIndexesApiGetLogsIndexRequest

Index

Properties

Properties

name

name: string

Name of the log index.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsIndexesApiUpdateLogsIndexOrderRequest.html b/interfaces/v1.LogsIndexesApiUpdateLogsIndexOrderRequest.html index 1d77929fcf3..343c3e8fd0a 100644 --- a/interfaces/v1.LogsIndexesApiUpdateLogsIndexOrderRequest.html +++ b/interfaces/v1.LogsIndexesApiUpdateLogsIndexOrderRequest.html @@ -1,3 +1,3 @@ -LogsIndexesApiUpdateLogsIndexOrderRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiUpdateLogsIndexOrderRequest

Hierarchy

  • LogsIndexesApiUpdateLogsIndexOrderRequest

Index

Properties

Properties

body

body: LogsIndexesOrder
+LogsIndexesApiUpdateLogsIndexOrderRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiUpdateLogsIndexOrderRequest

Hierarchy

  • LogsIndexesApiUpdateLogsIndexOrderRequest

Index

Properties

Properties

body

body: LogsIndexesOrder

Object containing the new ordered list of index names

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsIndexesApiUpdateLogsIndexRequest.html b/interfaces/v1.LogsIndexesApiUpdateLogsIndexRequest.html index ee5b89b0c6c..b49f0d49366 100644 --- a/interfaces/v1.LogsIndexesApiUpdateLogsIndexRequest.html +++ b/interfaces/v1.LogsIndexesApiUpdateLogsIndexRequest.html @@ -1,5 +1,5 @@ -LogsIndexesApiUpdateLogsIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiUpdateLogsIndexRequest

Hierarchy

  • LogsIndexesApiUpdateLogsIndexRequest

Index

Properties

Properties

body

body: LogsIndexUpdateRequest
+LogsIndexesApiUpdateLogsIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsIndexesApiUpdateLogsIndexRequest

Hierarchy

  • LogsIndexesApiUpdateLogsIndexRequest

Index

Properties

Properties

body

body: LogsIndexUpdateRequest

Object containing the new `LogsIndexUpdateRequest`.

-

name

name: string
+

name

name: string

Name of the log index.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsPipelinesApiCreateLogsPipelineRequest.html b/interfaces/v1.LogsPipelinesApiCreateLogsPipelineRequest.html index dc16cc7fe5c..90db458afa0 100644 --- a/interfaces/v1.LogsPipelinesApiCreateLogsPipelineRequest.html +++ b/interfaces/v1.LogsPipelinesApiCreateLogsPipelineRequest.html @@ -1,3 +1,3 @@ -LogsPipelinesApiCreateLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiCreateLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiCreateLogsPipelineRequest

Index

Properties

Properties

body

body: LogsPipeline
+LogsPipelinesApiCreateLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiCreateLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiCreateLogsPipelineRequest

Index

Properties

Properties

body

body: LogsPipeline

Definition of the new pipeline.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsPipelinesApiDeleteLogsPipelineRequest.html b/interfaces/v1.LogsPipelinesApiDeleteLogsPipelineRequest.html index 909ef4f748b..bcb107a0d7a 100644 --- a/interfaces/v1.LogsPipelinesApiDeleteLogsPipelineRequest.html +++ b/interfaces/v1.LogsPipelinesApiDeleteLogsPipelineRequest.html @@ -1,3 +1,3 @@ -LogsPipelinesApiDeleteLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiDeleteLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiDeleteLogsPipelineRequest

Index

Properties

Properties

pipelineId

pipelineId: string
+LogsPipelinesApiDeleteLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiDeleteLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiDeleteLogsPipelineRequest

Index

Properties

Properties

pipelineId

pipelineId: string

ID of the pipeline to delete.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsPipelinesApiGetLogsPipelineRequest.html b/interfaces/v1.LogsPipelinesApiGetLogsPipelineRequest.html index e5b8671dd35..41b20d8a1b7 100644 --- a/interfaces/v1.LogsPipelinesApiGetLogsPipelineRequest.html +++ b/interfaces/v1.LogsPipelinesApiGetLogsPipelineRequest.html @@ -1,3 +1,3 @@ -LogsPipelinesApiGetLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiGetLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiGetLogsPipelineRequest

Index

Properties

Properties

pipelineId

pipelineId: string
+LogsPipelinesApiGetLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiGetLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiGetLogsPipelineRequest

Index

Properties

Properties

pipelineId

pipelineId: string

ID of the pipeline to get.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineOrderRequest.html b/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineOrderRequest.html index f8ac0a70d39..017d2e6195f 100644 --- a/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineOrderRequest.html +++ b/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineOrderRequest.html @@ -1,3 +1,3 @@ -LogsPipelinesApiUpdateLogsPipelineOrderRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiUpdateLogsPipelineOrderRequest

Hierarchy

  • LogsPipelinesApiUpdateLogsPipelineOrderRequest

Index

Properties

Properties

body

body: LogsPipelinesOrder
+LogsPipelinesApiUpdateLogsPipelineOrderRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiUpdateLogsPipelineOrderRequest

Hierarchy

  • LogsPipelinesApiUpdateLogsPipelineOrderRequest

Index

Properties

Properties

body

body: LogsPipelinesOrder

Object containing the new ordered list of pipeline IDs.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineRequest.html b/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineRequest.html index a77c9039f51..b9416f4cbca 100644 --- a/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineRequest.html +++ b/interfaces/v1.LogsPipelinesApiUpdateLogsPipelineRequest.html @@ -1,5 +1,5 @@ -LogsPipelinesApiUpdateLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiUpdateLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiUpdateLogsPipelineRequest

Index

Properties

Properties

body

body: LogsPipeline
+LogsPipelinesApiUpdateLogsPipelineRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsPipelinesApiUpdateLogsPipelineRequest

Hierarchy

  • LogsPipelinesApiUpdateLogsPipelineRequest

Index

Properties

Properties

body

body: LogsPipeline

New definition of the pipeline.

-

pipelineId

pipelineId: string
+

pipelineId

pipelineId: string

ID of the pipeline to delete.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MetricsApiGetMetricMetadataRequest.html b/interfaces/v1.MetricsApiGetMetricMetadataRequest.html index cfe43cc7005..c3606d392dc 100644 --- a/interfaces/v1.MetricsApiGetMetricMetadataRequest.html +++ b/interfaces/v1.MetricsApiGetMetricMetadataRequest.html @@ -1,3 +1,3 @@ -MetricsApiGetMetricMetadataRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiGetMetricMetadataRequest

Hierarchy

  • MetricsApiGetMetricMetadataRequest

Index

Properties

Properties

metricName

metricName: string
+MetricsApiGetMetricMetadataRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiGetMetricMetadataRequest

Hierarchy

  • MetricsApiGetMetricMetadataRequest

Index

Properties

Properties

metricName

metricName: string

Name of the metric for which to get metadata.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MetricsApiListActiveMetricsRequest.html b/interfaces/v1.MetricsApiListActiveMetricsRequest.html index d017d6913bf..e4ab1ab24f9 100644 --- a/interfaces/v1.MetricsApiListActiveMetricsRequest.html +++ b/interfaces/v1.MetricsApiListActiveMetricsRequest.html @@ -1,7 +1,7 @@ -MetricsApiListActiveMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListActiveMetricsRequest

Hierarchy

  • MetricsApiListActiveMetricsRequest

Index

Properties

Properties

from

from: number
+MetricsApiListActiveMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListActiveMetricsRequest

Hierarchy

  • MetricsApiListActiveMetricsRequest

Index

Properties

Properties

from

from: number

Seconds since the Unix epoch.

-

Optional host

host?: string
+

Optional host

host?: string

Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag.

-

Optional tagFilter

tagFilter?: string
+

Optional tagFilter

tagFilter?: string

Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MetricsApiListMetricsRequest.html b/interfaces/v1.MetricsApiListMetricsRequest.html index c825d3a1c6e..b62d589d0a6 100644 --- a/interfaces/v1.MetricsApiListMetricsRequest.html +++ b/interfaces/v1.MetricsApiListMetricsRequest.html @@ -1,3 +1,3 @@ -MetricsApiListMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListMetricsRequest

Hierarchy

  • MetricsApiListMetricsRequest

Index

Properties

Properties

q

q: string
+MetricsApiListMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListMetricsRequest

Hierarchy

  • MetricsApiListMetricsRequest

Index

Properties

Properties

q

q: string

Query string to search metrics upon. Must be prefixed with `metrics:`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MetricsApiQueryMetricsRequest.html b/interfaces/v1.MetricsApiQueryMetricsRequest.html index 79426834a2f..df65892ae59 100644 --- a/interfaces/v1.MetricsApiQueryMetricsRequest.html +++ b/interfaces/v1.MetricsApiQueryMetricsRequest.html @@ -1,7 +1,7 @@ -MetricsApiQueryMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiQueryMetricsRequest

Hierarchy

  • MetricsApiQueryMetricsRequest

Index

Properties

Properties

from

from: number
+MetricsApiQueryMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiQueryMetricsRequest

Hierarchy

  • MetricsApiQueryMetricsRequest

Index

Properties

Properties

from

from: number

Start of the queried time period, seconds since the Unix epoch.

-

query

query: string
+

query

query: string

Query string.

-

to

to: number
+

to

to: number

End of the queried time period, seconds since the Unix epoch.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MetricsApiSubmitMetricsRequest.html b/interfaces/v1.MetricsApiSubmitMetricsRequest.html index f71e2b5f262..2865454a560 100644 --- a/interfaces/v1.MetricsApiSubmitMetricsRequest.html +++ b/interfaces/v1.MetricsApiSubmitMetricsRequest.html @@ -1,3 +1,3 @@ -MetricsApiSubmitMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiSubmitMetricsRequest

Hierarchy

  • MetricsApiSubmitMetricsRequest

Index

Properties

Properties

body

body: MetricsPayload

Optional contentEncoding

contentEncoding?: "deflate"
+MetricsApiSubmitMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiSubmitMetricsRequest

Hierarchy

  • MetricsApiSubmitMetricsRequest

Index

Properties

Properties

body

body: MetricsPayload

Optional contentEncoding

contentEncoding?: "deflate"

HTTP header used to compress the media-type.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MetricsApiUpdateMetricMetadataRequest.html b/interfaces/v1.MetricsApiUpdateMetricMetadataRequest.html index 550646781f5..e3a89426aee 100644 --- a/interfaces/v1.MetricsApiUpdateMetricMetadataRequest.html +++ b/interfaces/v1.MetricsApiUpdateMetricMetadataRequest.html @@ -1,5 +1,5 @@ -MetricsApiUpdateMetricMetadataRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiUpdateMetricMetadataRequest

Hierarchy

  • MetricsApiUpdateMetricMetadataRequest

Index

Properties

Properties

body

body: MetricMetadata
+MetricsApiUpdateMetricMetadataRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiUpdateMetricMetadataRequest

Hierarchy

  • MetricsApiUpdateMetricMetadataRequest

Index

Properties

Properties

body

body: MetricMetadata

New metadata.

-

metricName

metricName: string
+

metricName

metricName: string

Name of the metric for which to edit metadata.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiCheckCanDeleteMonitorRequest.html b/interfaces/v1.MonitorsApiCheckCanDeleteMonitorRequest.html index f674fa19e14..4b2706dd47e 100644 --- a/interfaces/v1.MonitorsApiCheckCanDeleteMonitorRequest.html +++ b/interfaces/v1.MonitorsApiCheckCanDeleteMonitorRequest.html @@ -1,3 +1,3 @@ -MonitorsApiCheckCanDeleteMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiCheckCanDeleteMonitorRequest

Hierarchy

  • MonitorsApiCheckCanDeleteMonitorRequest

Index

Properties

Properties

monitorIds

monitorIds: number[]
+MonitorsApiCheckCanDeleteMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiCheckCanDeleteMonitorRequest

Hierarchy

  • MonitorsApiCheckCanDeleteMonitorRequest

Index

Properties

Properties

monitorIds

monitorIds: number[]

The IDs of the monitor to check.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiCreateMonitorRequest.html b/interfaces/v1.MonitorsApiCreateMonitorRequest.html index 7bc3740d8f5..5729e7ce59f 100644 --- a/interfaces/v1.MonitorsApiCreateMonitorRequest.html +++ b/interfaces/v1.MonitorsApiCreateMonitorRequest.html @@ -1,3 +1,3 @@ -MonitorsApiCreateMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiCreateMonitorRequest

Hierarchy

  • MonitorsApiCreateMonitorRequest

Index

Properties

Properties

body

body: Monitor
+MonitorsApiCreateMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiCreateMonitorRequest

Hierarchy

  • MonitorsApiCreateMonitorRequest

Index

Properties

Properties

body

body: Monitor

Create a monitor request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiDeleteMonitorRequest.html b/interfaces/v1.MonitorsApiDeleteMonitorRequest.html index 4fc58ba6e71..15a286dbe8a 100644 --- a/interfaces/v1.MonitorsApiDeleteMonitorRequest.html +++ b/interfaces/v1.MonitorsApiDeleteMonitorRequest.html @@ -1,5 +1,5 @@ -MonitorsApiDeleteMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiDeleteMonitorRequest

Hierarchy

  • MonitorsApiDeleteMonitorRequest

Index

Properties

Properties

Optional force

force?: string
+MonitorsApiDeleteMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiDeleteMonitorRequest

Hierarchy

  • MonitorsApiDeleteMonitorRequest

Index

Properties

Properties

Optional force

force?: string

Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor).

-

monitorId

monitorId: number
+

monitorId

monitorId: number

The ID of the monitor.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiGetMonitorRequest.html b/interfaces/v1.MonitorsApiGetMonitorRequest.html index 0d112cac526..da01275098a 100644 --- a/interfaces/v1.MonitorsApiGetMonitorRequest.html +++ b/interfaces/v1.MonitorsApiGetMonitorRequest.html @@ -1,5 +1,5 @@ -MonitorsApiGetMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiGetMonitorRequest

Hierarchy

  • MonitorsApiGetMonitorRequest

Index

Properties

Properties

Optional groupStates

groupStates?: string
+MonitorsApiGetMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiGetMonitorRequest

Hierarchy

  • MonitorsApiGetMonitorRequest

Index

Properties

Properties

Optional groupStates

groupStates?: string

When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`.

-

monitorId

monitorId: number
+

monitorId

monitorId: number

The ID of the monitor

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiListMonitorsRequest.html b/interfaces/v1.MonitorsApiListMonitorsRequest.html index a1fe76854a1..12c4e15df27 100644 --- a/interfaces/v1.MonitorsApiListMonitorsRequest.html +++ b/interfaces/v1.MonitorsApiListMonitorsRequest.html @@ -1,17 +1,17 @@ -MonitorsApiListMonitorsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiListMonitorsRequest

Hierarchy

  • MonitorsApiListMonitorsRequest

Index

Properties

Properties

Optional groupStates

groupStates?: string
+MonitorsApiListMonitorsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiListMonitorsRequest

Hierarchy

  • MonitorsApiListMonitorsRequest

Index

Properties

Properties

Optional groupStates

groupStates?: string

When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`.

-

Optional idOffset

idOffset?: number
+

Optional idOffset

idOffset?: number

Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty.

-

Optional monitorTags

monitorTags?: string
+

Optional monitorTags

monitorTags?: string

A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`.

-

Optional name

name?: string
+

Optional name

name?: string

A string to filter monitors by name.

-

Optional page

page?: number
+

Optional page

page?: number

The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100.

-

Optional tags

tags?: string
+

Optional tags

tags?: string

A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, `host:host0`.

-

Optional withDowntimes

withDowntimes?: boolean
+

Optional withDowntimes

withDowntimes?: boolean

If this argument is set to true, then the returned data includes all current active downtimes for each monitor.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiSearchMonitorGroupsRequest.html b/interfaces/v1.MonitorsApiSearchMonitorGroupsRequest.html index 906945e498e..b6cfbf602fd 100644 --- a/interfaces/v1.MonitorsApiSearchMonitorGroupsRequest.html +++ b/interfaces/v1.MonitorsApiSearchMonitorGroupsRequest.html @@ -1,9 +1,9 @@ -MonitorsApiSearchMonitorGroupsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiSearchMonitorGroupsRequest

Hierarchy

  • MonitorsApiSearchMonitorGroupsRequest

Index

Properties

Properties

Optional page

page?: number
+MonitorsApiSearchMonitorGroupsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiSearchMonitorGroupsRequest

Hierarchy

  • MonitorsApiSearchMonitorGroupsRequest

Index

Properties

Properties

Optional page

page?: number

Page to start paginating from.

-

Optional perPage

perPage?: number
+

Optional perPage

perPage?: number

Number of monitors to return per page.

-

Optional query

query?: string
+

Optional query

query?: string

After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=&quot;type:metric status:alert&quot;`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors

-

Optional sort

sort?: string
+

Optional sort

sort?: string

String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags`

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiSearchMonitorsRequest.html b/interfaces/v1.MonitorsApiSearchMonitorsRequest.html index 4b2426ea157..b5d00b1e10a 100644 --- a/interfaces/v1.MonitorsApiSearchMonitorsRequest.html +++ b/interfaces/v1.MonitorsApiSearchMonitorsRequest.html @@ -1,9 +1,9 @@ -MonitorsApiSearchMonitorsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiSearchMonitorsRequest

Hierarchy

  • MonitorsApiSearchMonitorsRequest

Index

Properties

Properties

Optional page

page?: number
+MonitorsApiSearchMonitorsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiSearchMonitorsRequest

Hierarchy

  • MonitorsApiSearchMonitorsRequest

Index

Properties

Properties

Optional page

page?: number

Page to start paginating from.

-

Optional perPage

perPage?: number
+

Optional perPage

perPage?: number

Number of monitors to return per page.

-

Optional query

query?: string
+

Optional query

query?: string

After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=&quot;type:metric status:alert&quot;`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors

-

Optional sort

sort?: string
+

Optional sort

sort?: string

String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags`

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiUpdateMonitorRequest.html b/interfaces/v1.MonitorsApiUpdateMonitorRequest.html index 2e51a16b22b..d85020f0543 100644 --- a/interfaces/v1.MonitorsApiUpdateMonitorRequest.html +++ b/interfaces/v1.MonitorsApiUpdateMonitorRequest.html @@ -1,5 +1,5 @@ -MonitorsApiUpdateMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiUpdateMonitorRequest

Hierarchy

  • MonitorsApiUpdateMonitorRequest

Index

Properties

Properties

body

body: MonitorUpdateRequest
+MonitorsApiUpdateMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiUpdateMonitorRequest

Hierarchy

  • MonitorsApiUpdateMonitorRequest

Index

Properties

Properties

body

body: MonitorUpdateRequest

Edit a monitor request body.

-

monitorId

monitorId: number
+

monitorId

monitorId: number

The ID of the monitor.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.MonitorsApiValidateMonitorRequest.html b/interfaces/v1.MonitorsApiValidateMonitorRequest.html index 39b2a32a4b0..b1b7ffc83ae 100644 --- a/interfaces/v1.MonitorsApiValidateMonitorRequest.html +++ b/interfaces/v1.MonitorsApiValidateMonitorRequest.html @@ -1,3 +1,3 @@ -MonitorsApiValidateMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiValidateMonitorRequest

Hierarchy

  • MonitorsApiValidateMonitorRequest

Index

Properties

Properties

body

body: Monitor
+MonitorsApiValidateMonitorRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MonitorsApiValidateMonitorRequest

Hierarchy

  • MonitorsApiValidateMonitorRequest

Index

Properties

Properties

body

body: Monitor

Monitor request object

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.NotebooksApiCreateNotebookRequest.html b/interfaces/v1.NotebooksApiCreateNotebookRequest.html index 51121fd88cd..09fa4e9da00 100644 --- a/interfaces/v1.NotebooksApiCreateNotebookRequest.html +++ b/interfaces/v1.NotebooksApiCreateNotebookRequest.html @@ -1,3 +1,3 @@ -NotebooksApiCreateNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiCreateNotebookRequest

Hierarchy

  • NotebooksApiCreateNotebookRequest

Index

Properties

Properties

body

body: NotebookCreateRequest
+NotebooksApiCreateNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiCreateNotebookRequest

Hierarchy

  • NotebooksApiCreateNotebookRequest

Index

Properties

Properties

body

body: NotebookCreateRequest

The JSON description of the notebook you want to create.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.NotebooksApiDeleteNotebookRequest.html b/interfaces/v1.NotebooksApiDeleteNotebookRequest.html index 6ccdb638604..0334de909b4 100644 --- a/interfaces/v1.NotebooksApiDeleteNotebookRequest.html +++ b/interfaces/v1.NotebooksApiDeleteNotebookRequest.html @@ -1,3 +1,3 @@ -NotebooksApiDeleteNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiDeleteNotebookRequest

Hierarchy

  • NotebooksApiDeleteNotebookRequest

Index

Properties

Properties

notebookId

notebookId: number
+NotebooksApiDeleteNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiDeleteNotebookRequest

Hierarchy

  • NotebooksApiDeleteNotebookRequest

Index

Properties

Properties

notebookId

notebookId: number

Unique ID, assigned when you create the notebook.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.NotebooksApiGetNotebookRequest.html b/interfaces/v1.NotebooksApiGetNotebookRequest.html index 173f1d2fe19..4c29d2b30c7 100644 --- a/interfaces/v1.NotebooksApiGetNotebookRequest.html +++ b/interfaces/v1.NotebooksApiGetNotebookRequest.html @@ -1,3 +1,3 @@ -NotebooksApiGetNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiGetNotebookRequest

Hierarchy

  • NotebooksApiGetNotebookRequest

Index

Properties

Properties

notebookId

notebookId: number
+NotebooksApiGetNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiGetNotebookRequest

Hierarchy

  • NotebooksApiGetNotebookRequest

Index

Properties

Properties

notebookId

notebookId: number

Unique ID, assigned when you create the notebook.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.NotebooksApiListNotebooksRequest.html b/interfaces/v1.NotebooksApiListNotebooksRequest.html index c3acb414329..d4973905dc8 100644 --- a/interfaces/v1.NotebooksApiListNotebooksRequest.html +++ b/interfaces/v1.NotebooksApiListNotebooksRequest.html @@ -1,21 +1,21 @@ -NotebooksApiListNotebooksRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiListNotebooksRequest

Hierarchy

  • NotebooksApiListNotebooksRequest

Index

Properties

Properties

Optional authorHandle

authorHandle?: string
+NotebooksApiListNotebooksRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiListNotebooksRequest

Hierarchy

  • NotebooksApiListNotebooksRequest

Index

Properties

Properties

Optional authorHandle

authorHandle?: string

Return notebooks created by the given `author_handle`.

-

Optional count

count?: number
+

Optional count

count?: number

The number of notebooks to be returned.

-

Optional excludeAuthorHandle

excludeAuthorHandle?: string
+

Optional excludeAuthorHandle

excludeAuthorHandle?: string

Return notebooks not created by the given `author_handle`.

-

Optional includeCells

includeCells?: boolean
+

Optional includeCells

includeCells?: boolean

Value of `false` excludes the `cells` and global `time` for each notebook.

-

Optional isTemplate

isTemplate?: boolean
+

Optional isTemplate

isTemplate?: boolean

True value returns only template notebooks. Default is false (returns only non-template notebooks).

-

Optional query

query?: string
+

Optional query

query?: string

Return only notebooks with `query` string in notebook name or author handle.

-

Optional sortDir

sortDir?: string
+

Optional sortDir

sortDir?: string

Sort by direction `asc` or `desc`.

-

Optional sortField

sortField?: string
+

Optional sortField

sortField?: string

Sort by field `modified`, `name`, or `created`.

-

Optional start

start?: number
+

Optional start

start?: number

The index of the first notebook you want returned.

-

Optional type

type?: string
+

Optional type

type?: string

If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.NotebooksApiUpdateNotebookRequest.html b/interfaces/v1.NotebooksApiUpdateNotebookRequest.html index 3cd669ce5dc..369dd7b766d 100644 --- a/interfaces/v1.NotebooksApiUpdateNotebookRequest.html +++ b/interfaces/v1.NotebooksApiUpdateNotebookRequest.html @@ -1,5 +1,5 @@ -NotebooksApiUpdateNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiUpdateNotebookRequest

Hierarchy

  • NotebooksApiUpdateNotebookRequest

Index

Properties

Properties

body

body: NotebookUpdateRequest
+NotebooksApiUpdateNotebookRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebooksApiUpdateNotebookRequest

Hierarchy

  • NotebooksApiUpdateNotebookRequest

Index

Properties

Properties

body

body: NotebookUpdateRequest

Update notebook request body.

-

notebookId

notebookId: number
+

notebookId

notebookId: number

Unique ID, assigned when you create the notebook.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.OrganizationsApiCreateChildOrgRequest.html b/interfaces/v1.OrganizationsApiCreateChildOrgRequest.html index c54e24468fc..46112b4afb4 100644 --- a/interfaces/v1.OrganizationsApiCreateChildOrgRequest.html +++ b/interfaces/v1.OrganizationsApiCreateChildOrgRequest.html @@ -1,3 +1,3 @@ -OrganizationsApiCreateChildOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiCreateChildOrgRequest

Hierarchy

  • OrganizationsApiCreateChildOrgRequest

Index

Properties

Properties

body

body: OrganizationCreateBody
+OrganizationsApiCreateChildOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiCreateChildOrgRequest

Hierarchy

  • OrganizationsApiCreateChildOrgRequest

Index

Properties

Properties

body

body: OrganizationCreateBody

Organization object that needs to be created

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.OrganizationsApiGetOrgRequest.html b/interfaces/v1.OrganizationsApiGetOrgRequest.html index ba125db778d..9a8c36e9655 100644 --- a/interfaces/v1.OrganizationsApiGetOrgRequest.html +++ b/interfaces/v1.OrganizationsApiGetOrgRequest.html @@ -1,3 +1,3 @@ -OrganizationsApiGetOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiGetOrgRequest

Hierarchy

  • OrganizationsApiGetOrgRequest

Index

Properties

Properties

publicId

publicId: string
+OrganizationsApiGetOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiGetOrgRequest

Hierarchy

  • OrganizationsApiGetOrgRequest

Index

Properties

Properties

publicId

publicId: string

The `public_id` of the organization you are operating within.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.OrganizationsApiUpdateOrgRequest.html b/interfaces/v1.OrganizationsApiUpdateOrgRequest.html index e7385deff61..15e163c5e2d 100644 --- a/interfaces/v1.OrganizationsApiUpdateOrgRequest.html +++ b/interfaces/v1.OrganizationsApiUpdateOrgRequest.html @@ -1,3 +1,3 @@ -OrganizationsApiUpdateOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiUpdateOrgRequest

Hierarchy

  • OrganizationsApiUpdateOrgRequest

Index

Properties

Properties

body

body: v1.Organization

publicId

publicId: string
+OrganizationsApiUpdateOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiUpdateOrgRequest

Hierarchy

  • OrganizationsApiUpdateOrgRequest

Index

Properties

Properties

body

body: v1.Organization

publicId

publicId: string

The `public_id` of the organization you are operating within.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.OrganizationsApiUploadIdPForOrgRequest.html b/interfaces/v1.OrganizationsApiUploadIdPForOrgRequest.html index d352488f221..5c452fc04b7 100644 --- a/interfaces/v1.OrganizationsApiUploadIdPForOrgRequest.html +++ b/interfaces/v1.OrganizationsApiUploadIdPForOrgRequest.html @@ -1,5 +1,5 @@ -OrganizationsApiUploadIdPForOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiUploadIdPForOrgRequest

Hierarchy

  • OrganizationsApiUploadIdPForOrgRequest

Index

Properties

Properties

idpFile

idpFile: v1.HttpFile
+OrganizationsApiUploadIdPForOrgRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OrganizationsApiUploadIdPForOrgRequest

Hierarchy

  • OrganizationsApiUploadIdPForOrgRequest

Index

Properties

Properties

idpFile

idpFile: v1.HttpFile

The path to the XML metadata file you wish to upload.

-

publicId

publicId: string
+

publicId

publicId: string

The `public_id` of the organization you are operating with

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest.html b/interfaces/v1.PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest.html index b65109c14bd..18967eea087 100644 --- a/interfaces/v1.PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest.html +++ b/interfaces/v1.PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest.html @@ -1,3 +1,3 @@ -PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest

Index

Properties

Properties

body

body: PagerDutyService
+PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiCreatePagerDutyIntegrationServiceRequest

Index

Properties

Properties

body

body: PagerDutyService

Create a new service object request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest.html b/interfaces/v1.PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest.html index 80579c7f142..0b145555c79 100644 --- a/interfaces/v1.PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest.html +++ b/interfaces/v1.PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest.html @@ -1,3 +1,3 @@ -PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest

Index

Properties

Properties

serviceName

serviceName: string
+PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiDeletePagerDutyIntegrationServiceRequest

Index

Properties

Properties

serviceName

serviceName: string

The service name

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest.html b/interfaces/v1.PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest.html index 09567e90bce..f1244e1b7b0 100644 --- a/interfaces/v1.PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest.html +++ b/interfaces/v1.PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest.html @@ -1,3 +1,3 @@ -PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest

Index

Properties

Properties

serviceName

serviceName: string
+PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiGetPagerDutyIntegrationServiceRequest

Index

Properties

Properties

serviceName

serviceName: string

The service name.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest.html b/interfaces/v1.PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest.html index ec146c5a353..20da13c36c4 100644 --- a/interfaces/v1.PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest.html +++ b/interfaces/v1.PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest.html @@ -1,5 +1,5 @@ -PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest

Index

Properties

Properties

body

body: PagerDutyServiceKey
+PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest

Hierarchy

  • PagerDutyIntegrationApiUpdatePagerDutyIntegrationServiceRequest

Index

Properties

Properties

body

body: PagerDutyServiceKey

Update an existing service object request body.

-

serviceName

serviceName: string
+

serviceName

serviceName: string

The service name

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ResponseBody.html b/interfaces/v1.ResponseBody.html index 3120b05d081..7b881e75441 100644 --- a/interfaces/v1.ResponseBody.html +++ b/interfaces/v1.ResponseBody.html @@ -1 +1 @@ -ResponseBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResponseBody

Hierarchy

  • ResponseBody

Implemented by

Index

Methods

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +ResponseBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResponseBody

Hierarchy

  • ResponseBody

Implemented by

Index

Methods

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SecurityAuthentication.html b/interfaces/v1.SecurityAuthentication.html index ab68baa9049..da2b443a0a8 100644 --- a/interfaces/v1.SecurityAuthentication.html +++ b/interfaces/v1.SecurityAuthentication.html @@ -1,6 +1,6 @@ SecurityAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityAuthentication

Interface authentication schemes.

-

Hierarchy

  • SecurityAuthentication

Implemented by

Index

Methods

Methods

applySecurityAuthentication

Hierarchy

  • SecurityAuthentication

Implemented by

Index

Methods

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceChecksApiSubmitServiceCheckRequest.html b/interfaces/v1.ServiceChecksApiSubmitServiceCheckRequest.html index e7250747d4e..1bcf12a38b0 100644 --- a/interfaces/v1.ServiceChecksApiSubmitServiceCheckRequest.html +++ b/interfaces/v1.ServiceChecksApiSubmitServiceCheckRequest.html @@ -1,3 +1,3 @@ -ServiceChecksApiSubmitServiceCheckRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceChecksApiSubmitServiceCheckRequest

Hierarchy

  • ServiceChecksApiSubmitServiceCheckRequest

Index

Properties

Properties

body

body: ServiceCheck[]
+ServiceChecksApiSubmitServiceCheckRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceChecksApiSubmitServiceCheckRequest

Hierarchy

  • ServiceChecksApiSubmitServiceCheckRequest

Index

Properties

Properties

body

body: ServiceCheck[]

Service Check request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest.html b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest.html index fcb0f7b0778..9b96b396e22 100644 --- a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest.html +++ b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest

Index

Properties

Properties

body

body: SLOCorrectionCreateRequest
+ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiCreateSLOCorrectionRequest

Index

Properties

Properties

body

body: SLOCorrectionCreateRequest

Create an SLO Correction

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest.html b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest.html index b492d3e1340..d5b5618a117 100644 --- a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest.html +++ b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest

Index

Properties

Properties

sloCorrectionId

sloCorrectionId: string
+ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiDeleteSLOCorrectionRequest

Index

Properties

Properties

sloCorrectionId

sloCorrectionId: string

The ID of the SLO correction object.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest.html b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest.html index 252884dc8ed..8ef75f6b366 100644 --- a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest.html +++ b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest

Index

Properties

Properties

sloCorrectionId

sloCorrectionId: string
+ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiGetSLOCorrectionRequest

Index

Properties

Properties

sloCorrectionId

sloCorrectionId: string

The ID of the SLO correction object.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest.html b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest.html index 6cc99c93304..72a2d87b53e 100644 --- a/interfaces/v1.ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest.html +++ b/interfaces/v1.ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest.html @@ -1,5 +1,5 @@ -ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest

Index

Properties

Properties

body

body: SLOCorrectionUpdateRequest
+ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest

Hierarchy

  • ServiceLevelObjectiveCorrectionsApiUpdateSLOCorrectionRequest

Index

Properties

Properties

body

body: SLOCorrectionUpdateRequest

The edited SLO correction object.

-

sloCorrectionId

sloCorrectionId: string
+

sloCorrectionId

sloCorrectionId: string

The ID of the SLO correction object.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiCheckCanDeleteSLORequest.html b/interfaces/v1.ServiceLevelObjectivesApiCheckCanDeleteSLORequest.html index f326fbf6a87..aa42066ed29 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiCheckCanDeleteSLORequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiCheckCanDeleteSLORequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectivesApiCheckCanDeleteSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiCheckCanDeleteSLORequest

Hierarchy

  • ServiceLevelObjectivesApiCheckCanDeleteSLORequest

Index

Properties

Properties

ids

ids: string
+ServiceLevelObjectivesApiCheckCanDeleteSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiCheckCanDeleteSLORequest

Hierarchy

  • ServiceLevelObjectivesApiCheckCanDeleteSLORequest

Index

Properties

Properties

ids

ids: string

A comma separated list of the IDs of the service level objectives objects.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiCreateSLORequest.html b/interfaces/v1.ServiceLevelObjectivesApiCreateSLORequest.html index 2e2e724576b..ea61c292754 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiCreateSLORequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiCreateSLORequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectivesApiCreateSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiCreateSLORequest

Hierarchy

  • ServiceLevelObjectivesApiCreateSLORequest

Index

Properties

Properties

body

body: ServiceLevelObjectiveRequest
+ServiceLevelObjectivesApiCreateSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiCreateSLORequest

Hierarchy

  • ServiceLevelObjectivesApiCreateSLORequest

Index

Properties

Properties

body

body: ServiceLevelObjectiveRequest

Service level objective request object.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiDeleteSLORequest.html b/interfaces/v1.ServiceLevelObjectivesApiDeleteSLORequest.html index 9ab1ac930d4..2816a5495b3 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiDeleteSLORequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiDeleteSLORequest.html @@ -1,5 +1,5 @@ -ServiceLevelObjectivesApiDeleteSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiDeleteSLORequest

Hierarchy

  • ServiceLevelObjectivesApiDeleteSLORequest

Index

Properties

Properties

Optional force

force?: string
+ServiceLevelObjectivesApiDeleteSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiDeleteSLORequest

Hierarchy

  • ServiceLevelObjectivesApiDeleteSLORequest

Index

Properties

Properties

Optional force

force?: string

Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor).

-

sloId

sloId: string
+

sloId

sloId: string

The ID of the service level objective.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest.html b/interfaces/v1.ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest.html index f10c1103065..b19830618e9 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest

Hierarchy

  • ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest

Index

Properties

Properties

body

body: {}
+ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest

Hierarchy

  • ServiceLevelObjectivesApiDeleteSLOTimeframeInBulkRequest

Index

Properties

Properties

body

body: {}

Delete multiple service level objective objects request body.

Type declaration

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiGetSLOCorrectionsRequest.html b/interfaces/v1.ServiceLevelObjectivesApiGetSLOCorrectionsRequest.html index 5fb97c3d9ee..2a64d80cbf3 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiGetSLOCorrectionsRequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiGetSLOCorrectionsRequest.html @@ -1,3 +1,3 @@ -ServiceLevelObjectivesApiGetSLOCorrectionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiGetSLOCorrectionsRequest

Hierarchy

  • ServiceLevelObjectivesApiGetSLOCorrectionsRequest

Index

Properties

Properties

sloId

sloId: string
+ServiceLevelObjectivesApiGetSLOCorrectionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiGetSLOCorrectionsRequest

Hierarchy

  • ServiceLevelObjectivesApiGetSLOCorrectionsRequest

Index

Properties

Properties

sloId

sloId: string

The ID of the service level objective object.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiGetSLOHistoryRequest.html b/interfaces/v1.ServiceLevelObjectivesApiGetSLOHistoryRequest.html index d3d7fc81e7d..b143a479816 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiGetSLOHistoryRequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiGetSLOHistoryRequest.html @@ -1,11 +1,11 @@ -ServiceLevelObjectivesApiGetSLOHistoryRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiGetSLOHistoryRequest

Hierarchy

  • ServiceLevelObjectivesApiGetSLOHistoryRequest

Index

Properties

Properties

Optional applyCorrection

applyCorrection?: boolean
+ServiceLevelObjectivesApiGetSLOHistoryRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiGetSLOHistoryRequest

Hierarchy

  • ServiceLevelObjectivesApiGetSLOHistoryRequest

Index

Properties

Properties

Optional applyCorrection

applyCorrection?: boolean

Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`, then the corrections will not be applied and the SLI values will not be affected.

-

fromTs

fromTs: number
+

fromTs

fromTs: number

The `from` timestamp for the query window in epoch seconds.

-

sloId

sloId: string
+

sloId

sloId: string

The ID of the service level objective object.

-

Optional target

target?: number
+

Optional target

target?: number

The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`.

-

toTs

toTs: number
+

toTs

toTs: number

The `to` timestamp for the query window in epoch seconds.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiGetSLORequest.html b/interfaces/v1.ServiceLevelObjectivesApiGetSLORequest.html index e6782329f3b..423c39d02ca 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiGetSLORequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiGetSLORequest.html @@ -1,5 +1,5 @@ -ServiceLevelObjectivesApiGetSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiGetSLORequest

Hierarchy

  • ServiceLevelObjectivesApiGetSLORequest

Index

Properties

Properties

sloId

sloId: string
+ServiceLevelObjectivesApiGetSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiGetSLORequest

Hierarchy

  • ServiceLevelObjectivesApiGetSLORequest

Index

Properties

Properties

sloId

sloId: string

The ID of the service level objective object.

-

Optional withConfiguredAlertIds

withConfiguredAlertIds?: boolean
+

Optional withConfiguredAlertIds

withConfiguredAlertIds?: boolean

Get the IDs of SLO monitors that reference this SLO.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiListSLOsRequest.html b/interfaces/v1.ServiceLevelObjectivesApiListSLOsRequest.html index 02118eb1835..fea2ec2b8fb 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiListSLOsRequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiListSLOsRequest.html @@ -1,13 +1,13 @@ -ServiceLevelObjectivesApiListSLOsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiListSLOsRequest

Hierarchy

  • ServiceLevelObjectivesApiListSLOsRequest

Index

Properties

Properties

Optional ids

ids?: string
+ServiceLevelObjectivesApiListSLOsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiListSLOsRequest

Hierarchy

  • ServiceLevelObjectivesApiListSLOsRequest

Index

Properties

Properties

Optional ids

ids?: string

A comma separated list of the IDs of the service level objectives objects.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

The number of SLOs to return in the response.

-

Optional metricsQuery

metricsQuery?: string
+

Optional metricsQuery

metricsQuery?: string

The query string to filter results based on SLO numerator and denominator.

-

Optional offset

offset?: number
+

Optional offset

offset?: number

The specific offset to use as the beginning of the returned response.

-

Optional query

query?: string
+

Optional query

query?: string

The query string to filter results based on SLO names.

-

Optional tagsQuery

tagsQuery?: string
+

Optional tagsQuery

tagsQuery?: string

The query string to filter results based on a single SLO tag.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.ServiceLevelObjectivesApiUpdateSLORequest.html b/interfaces/v1.ServiceLevelObjectivesApiUpdateSLORequest.html index fb37884f8cb..a55fdce08c6 100644 --- a/interfaces/v1.ServiceLevelObjectivesApiUpdateSLORequest.html +++ b/interfaces/v1.ServiceLevelObjectivesApiUpdateSLORequest.html @@ -1,5 +1,5 @@ -ServiceLevelObjectivesApiUpdateSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiUpdateSLORequest

Hierarchy

  • ServiceLevelObjectivesApiUpdateSLORequest

Index

Properties

Properties

body

body: ServiceLevelObjective
+ServiceLevelObjectivesApiUpdateSLORequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceLevelObjectivesApiUpdateSLORequest

Hierarchy

  • ServiceLevelObjectivesApiUpdateSLORequest

Index

Properties

Properties

body

body: ServiceLevelObjective

The edited service level objective request object.

-

sloId

sloId: string
+

sloId

sloId: string

The ID of the service level objective object.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SlackIntegrationApiCreateSlackIntegrationChannelRequest.html b/interfaces/v1.SlackIntegrationApiCreateSlackIntegrationChannelRequest.html index 0fd40bad73b..1d64152877e 100644 --- a/interfaces/v1.SlackIntegrationApiCreateSlackIntegrationChannelRequest.html +++ b/interfaces/v1.SlackIntegrationApiCreateSlackIntegrationChannelRequest.html @@ -1,5 +1,5 @@ -SlackIntegrationApiCreateSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiCreateSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiCreateSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string
+SlackIntegrationApiCreateSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiCreateSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiCreateSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string

Your Slack account name.

-

body

body: SlackIntegrationChannel
+

body

body: SlackIntegrationChannel

Payload describing Slack channel to be created

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelRequest.html b/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelRequest.html index 179dda1e692..c0d200f5488 100644 --- a/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelRequest.html +++ b/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelRequest.html @@ -1,5 +1,5 @@ -SlackIntegrationApiGetSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiGetSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiGetSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string
+SlackIntegrationApiGetSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiGetSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiGetSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string

Your Slack account name.

-

channelName

channelName: string
+

channelName

channelName: string

The name of the Slack channel being operated on.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelsRequest.html b/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelsRequest.html index 5ed8bca98c4..c4005e289f0 100644 --- a/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelsRequest.html +++ b/interfaces/v1.SlackIntegrationApiGetSlackIntegrationChannelsRequest.html @@ -1,3 +1,3 @@ -SlackIntegrationApiGetSlackIntegrationChannelsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiGetSlackIntegrationChannelsRequest

Hierarchy

  • SlackIntegrationApiGetSlackIntegrationChannelsRequest

Index

Properties

Properties

accountName

accountName: string
+SlackIntegrationApiGetSlackIntegrationChannelsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiGetSlackIntegrationChannelsRequest

Hierarchy

  • SlackIntegrationApiGetSlackIntegrationChannelsRequest

Index

Properties

Properties

accountName

accountName: string

Your Slack account name.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SlackIntegrationApiRemoveSlackIntegrationChannelRequest.html b/interfaces/v1.SlackIntegrationApiRemoveSlackIntegrationChannelRequest.html index 85ee3982486..ea330a2df82 100644 --- a/interfaces/v1.SlackIntegrationApiRemoveSlackIntegrationChannelRequest.html +++ b/interfaces/v1.SlackIntegrationApiRemoveSlackIntegrationChannelRequest.html @@ -1,5 +1,5 @@ -SlackIntegrationApiRemoveSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiRemoveSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiRemoveSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string
+SlackIntegrationApiRemoveSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiRemoveSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiRemoveSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string

Your Slack account name.

-

channelName

channelName: string
+

channelName

channelName: string

The name of the Slack channel being operated on.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SlackIntegrationApiUpdateSlackIntegrationChannelRequest.html b/interfaces/v1.SlackIntegrationApiUpdateSlackIntegrationChannelRequest.html index 27e9a6f67b5..3b693ebd300 100644 --- a/interfaces/v1.SlackIntegrationApiUpdateSlackIntegrationChannelRequest.html +++ b/interfaces/v1.SlackIntegrationApiUpdateSlackIntegrationChannelRequest.html @@ -1,7 +1,7 @@ -SlackIntegrationApiUpdateSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiUpdateSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiUpdateSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string
+SlackIntegrationApiUpdateSlackIntegrationChannelRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SlackIntegrationApiUpdateSlackIntegrationChannelRequest

Hierarchy

  • SlackIntegrationApiUpdateSlackIntegrationChannelRequest

Index

Properties

Properties

accountName

accountName: string

Your Slack account name.

-

body

body: SlackIntegrationChannel
+

body

body: SlackIntegrationChannel

Payload describing fields and values to be updated.

-

channelName

channelName: string
+

channelName

channelName: string

The name of the Slack channel being operated on.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SnapshotsApiGetGraphSnapshotRequest.html b/interfaces/v1.SnapshotsApiGetGraphSnapshotRequest.html index 1eac1974b51..8c7f3108c6c 100644 --- a/interfaces/v1.SnapshotsApiGetGraphSnapshotRequest.html +++ b/interfaces/v1.SnapshotsApiGetGraphSnapshotRequest.html @@ -1,13 +1,13 @@ -SnapshotsApiGetGraphSnapshotRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SnapshotsApiGetGraphSnapshotRequest

Hierarchy

  • SnapshotsApiGetGraphSnapshotRequest

Index

Properties

Properties

end

end: number
+SnapshotsApiGetGraphSnapshotRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SnapshotsApiGetGraphSnapshotRequest

Hierarchy

  • SnapshotsApiGetGraphSnapshotRequest

Index

Properties

Properties

end

end: number

The POSIX timestamp of the end of the query.

-

Optional eventQuery

eventQuery?: string
+

Optional eventQuery

eventQuery?: string

A query that adds event bands to the graph.

-

Optional graphDef

graphDef?: string
+

Optional graphDef

graphDef?: string

A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded.

-

Optional metricQuery

metricQuery?: string
+

Optional metricQuery

metricQuery?: string

The metric query.

-

start

start: number
+

start

start: number

The POSIX timestamp of the start of the query.

-

Optional title

title?: string
+

Optional title

title?: string

A title for the graph. If no title is specified, the graph does not have a title.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiCreateGlobalVariableRequest.html b/interfaces/v1.SyntheticsApiCreateGlobalVariableRequest.html index a9ae98324f5..d584063d5c1 100644 --- a/interfaces/v1.SyntheticsApiCreateGlobalVariableRequest.html +++ b/interfaces/v1.SyntheticsApiCreateGlobalVariableRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiCreateGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreateGlobalVariableRequest

Hierarchy

  • SyntheticsApiCreateGlobalVariableRequest

Index

Properties

Properties

body

body: SyntheticsGlobalVariable
+SyntheticsApiCreateGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreateGlobalVariableRequest

Hierarchy

  • SyntheticsApiCreateGlobalVariableRequest

Index

Properties

Properties

body

body: SyntheticsGlobalVariable

Details of the global variable to create.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiCreatePrivateLocationRequest.html b/interfaces/v1.SyntheticsApiCreatePrivateLocationRequest.html index 2ade1f0329d..64d2b95dbb1 100644 --- a/interfaces/v1.SyntheticsApiCreatePrivateLocationRequest.html +++ b/interfaces/v1.SyntheticsApiCreatePrivateLocationRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiCreatePrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreatePrivateLocationRequest

Hierarchy

  • SyntheticsApiCreatePrivateLocationRequest

Index

Properties

Properties

body

body: SyntheticsPrivateLocation
+SyntheticsApiCreatePrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreatePrivateLocationRequest

Hierarchy

  • SyntheticsApiCreatePrivateLocationRequest

Index

Properties

Properties

body

body: SyntheticsPrivateLocation

Details of the private location to create.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiCreateSyntheticsAPITestRequest.html b/interfaces/v1.SyntheticsApiCreateSyntheticsAPITestRequest.html index c9e7b214cb2..669b06b2663 100644 --- a/interfaces/v1.SyntheticsApiCreateSyntheticsAPITestRequest.html +++ b/interfaces/v1.SyntheticsApiCreateSyntheticsAPITestRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiCreateSyntheticsAPITestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreateSyntheticsAPITestRequest

Hierarchy

  • SyntheticsApiCreateSyntheticsAPITestRequest

Index

Properties

Properties

body

body: SyntheticsAPITest
+SyntheticsApiCreateSyntheticsAPITestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreateSyntheticsAPITestRequest

Hierarchy

  • SyntheticsApiCreateSyntheticsAPITestRequest

Index

Properties

Properties

body

body: SyntheticsAPITest

Details of the test to create.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiCreateSyntheticsBrowserTestRequest.html b/interfaces/v1.SyntheticsApiCreateSyntheticsBrowserTestRequest.html index f964f3ab292..48dcf0bdcfc 100644 --- a/interfaces/v1.SyntheticsApiCreateSyntheticsBrowserTestRequest.html +++ b/interfaces/v1.SyntheticsApiCreateSyntheticsBrowserTestRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiCreateSyntheticsBrowserTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreateSyntheticsBrowserTestRequest

Hierarchy

  • SyntheticsApiCreateSyntheticsBrowserTestRequest

Index

Properties

Properties

body

body: SyntheticsBrowserTest
+SyntheticsApiCreateSyntheticsBrowserTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiCreateSyntheticsBrowserTestRequest

Hierarchy

  • SyntheticsApiCreateSyntheticsBrowserTestRequest

Index

Properties

Properties

body

body: SyntheticsBrowserTest

Details of the test to create.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiDeleteGlobalVariableRequest.html b/interfaces/v1.SyntheticsApiDeleteGlobalVariableRequest.html index 59b3a0f3cce..dd341fe0f04 100644 --- a/interfaces/v1.SyntheticsApiDeleteGlobalVariableRequest.html +++ b/interfaces/v1.SyntheticsApiDeleteGlobalVariableRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiDeleteGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiDeleteGlobalVariableRequest

Hierarchy

  • SyntheticsApiDeleteGlobalVariableRequest

Index

Properties

Properties

variableId

variableId: string
+SyntheticsApiDeleteGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiDeleteGlobalVariableRequest

Hierarchy

  • SyntheticsApiDeleteGlobalVariableRequest

Index

Properties

Properties

variableId

variableId: string

The ID of the global variable.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiDeletePrivateLocationRequest.html b/interfaces/v1.SyntheticsApiDeletePrivateLocationRequest.html index ae1f8b0a1c9..d2540110102 100644 --- a/interfaces/v1.SyntheticsApiDeletePrivateLocationRequest.html +++ b/interfaces/v1.SyntheticsApiDeletePrivateLocationRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiDeletePrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiDeletePrivateLocationRequest

Hierarchy

  • SyntheticsApiDeletePrivateLocationRequest

Index

Properties

Properties

locationId

locationId: string
+SyntheticsApiDeletePrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiDeletePrivateLocationRequest

Hierarchy

  • SyntheticsApiDeletePrivateLocationRequest

Index

Properties

Properties

locationId

locationId: string

The ID of the private location.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiDeleteTestsRequest.html b/interfaces/v1.SyntheticsApiDeleteTestsRequest.html index 9bb6fc3e663..2ccdcd735eb 100644 --- a/interfaces/v1.SyntheticsApiDeleteTestsRequest.html +++ b/interfaces/v1.SyntheticsApiDeleteTestsRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiDeleteTestsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiDeleteTestsRequest

Hierarchy

  • SyntheticsApiDeleteTestsRequest

Index

Properties

Properties

body

body: SyntheticsDeleteTestsPayload
+SyntheticsApiDeleteTestsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiDeleteTestsRequest

Hierarchy

  • SyntheticsApiDeleteTestsRequest

Index

Properties

Properties

body

body: SyntheticsDeleteTestsPayload

Public ID list of the Synthetic tests to be deleted.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiEditGlobalVariableRequest.html b/interfaces/v1.SyntheticsApiEditGlobalVariableRequest.html index 5c812add7c6..81c90cd9a30 100644 --- a/interfaces/v1.SyntheticsApiEditGlobalVariableRequest.html +++ b/interfaces/v1.SyntheticsApiEditGlobalVariableRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiEditGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiEditGlobalVariableRequest

Hierarchy

  • SyntheticsApiEditGlobalVariableRequest

Index

Properties

Properties

body

body: SyntheticsGlobalVariable
+SyntheticsApiEditGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiEditGlobalVariableRequest

Hierarchy

  • SyntheticsApiEditGlobalVariableRequest

Index

Properties

Properties

body

body: SyntheticsGlobalVariable

Details of the global variable to update.

-

variableId

variableId: string
+

variableId

variableId: string

The ID of the global variable.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetAPITestLatestResultsRequest.html b/interfaces/v1.SyntheticsApiGetAPITestLatestResultsRequest.html index 400f65b14c9..224df098417 100644 --- a/interfaces/v1.SyntheticsApiGetAPITestLatestResultsRequest.html +++ b/interfaces/v1.SyntheticsApiGetAPITestLatestResultsRequest.html @@ -1,9 +1,9 @@ -SyntheticsApiGetAPITestLatestResultsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetAPITestLatestResultsRequest

Hierarchy

  • SyntheticsApiGetAPITestLatestResultsRequest

Index

Properties

Properties

Optional fromTs

fromTs?: number
+SyntheticsApiGetAPITestLatestResultsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetAPITestLatestResultsRequest

Hierarchy

  • SyntheticsApiGetAPITestLatestResultsRequest

Index

Properties

Properties

Optional fromTs

fromTs?: number

Timestamp in milliseconds from which to start querying results.

-

Optional probeDc

probeDc?: string[]
+

Optional probeDc

probeDc?: string[]

Locations for which to query results.

-

publicId

publicId: string
+

publicId

publicId: string

The public ID of the test for which to search results for.

-

Optional toTs

toTs?: number
+

Optional toTs

toTs?: number

Timestamp in milliseconds up to which to query results.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetAPITestRequest.html b/interfaces/v1.SyntheticsApiGetAPITestRequest.html index cad482db104..f45110318d0 100644 --- a/interfaces/v1.SyntheticsApiGetAPITestRequest.html +++ b/interfaces/v1.SyntheticsApiGetAPITestRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiGetAPITestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetAPITestRequest

Hierarchy

  • SyntheticsApiGetAPITestRequest

Index

Properties

Properties

publicId

publicId: string
+SyntheticsApiGetAPITestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetAPITestRequest

Hierarchy

  • SyntheticsApiGetAPITestRequest

Index

Properties

Properties

publicId

publicId: string

The public ID of the test to get details from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetAPITestResultRequest.html b/interfaces/v1.SyntheticsApiGetAPITestResultRequest.html index 02062941efe..6dd1f4255eb 100644 --- a/interfaces/v1.SyntheticsApiGetAPITestResultRequest.html +++ b/interfaces/v1.SyntheticsApiGetAPITestResultRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiGetAPITestResultRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetAPITestResultRequest

Hierarchy

  • SyntheticsApiGetAPITestResultRequest

Index

Properties

Properties

publicId

publicId: string
+SyntheticsApiGetAPITestResultRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetAPITestResultRequest

Hierarchy

  • SyntheticsApiGetAPITestResultRequest

Index

Properties

Properties

publicId

publicId: string

The public ID of the API test to which the target result belongs.

-

resultId

resultId: string
+

resultId

resultId: string

The ID of the result to get.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetBrowserTestLatestResultsRequest.html b/interfaces/v1.SyntheticsApiGetBrowserTestLatestResultsRequest.html index 994788f0307..695c2df09a5 100644 --- a/interfaces/v1.SyntheticsApiGetBrowserTestLatestResultsRequest.html +++ b/interfaces/v1.SyntheticsApiGetBrowserTestLatestResultsRequest.html @@ -1,9 +1,9 @@ -SyntheticsApiGetBrowserTestLatestResultsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetBrowserTestLatestResultsRequest

Hierarchy

  • SyntheticsApiGetBrowserTestLatestResultsRequest

Index

Properties

Properties

Optional fromTs

fromTs?: number
+SyntheticsApiGetBrowserTestLatestResultsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetBrowserTestLatestResultsRequest

Hierarchy

  • SyntheticsApiGetBrowserTestLatestResultsRequest

Index

Properties

Properties

Optional fromTs

fromTs?: number

Timestamp in milliseconds from which to start querying results.

-

Optional probeDc

probeDc?: string[]
+

Optional probeDc

probeDc?: string[]

Locations for which to query results.

-

publicId

publicId: string
+

publicId

publicId: string

The public ID of the browser test for which to search results for.

-

Optional toTs

toTs?: number
+

Optional toTs

toTs?: number

Timestamp in milliseconds up to which to query results.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetBrowserTestRequest.html b/interfaces/v1.SyntheticsApiGetBrowserTestRequest.html index 08764b05109..5ef37958f2a 100644 --- a/interfaces/v1.SyntheticsApiGetBrowserTestRequest.html +++ b/interfaces/v1.SyntheticsApiGetBrowserTestRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiGetBrowserTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetBrowserTestRequest

Hierarchy

  • SyntheticsApiGetBrowserTestRequest

Index

Properties

Properties

publicId

publicId: string
+SyntheticsApiGetBrowserTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetBrowserTestRequest

Hierarchy

  • SyntheticsApiGetBrowserTestRequest

Index

Properties

Properties

publicId

publicId: string

The public ID of the test to get details from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetBrowserTestResultRequest.html b/interfaces/v1.SyntheticsApiGetBrowserTestResultRequest.html index a177cb20c38..3c7deb55384 100644 --- a/interfaces/v1.SyntheticsApiGetBrowserTestResultRequest.html +++ b/interfaces/v1.SyntheticsApiGetBrowserTestResultRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiGetBrowserTestResultRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetBrowserTestResultRequest

Hierarchy

  • SyntheticsApiGetBrowserTestResultRequest

Index

Properties

Properties

publicId

publicId: string
+SyntheticsApiGetBrowserTestResultRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetBrowserTestResultRequest

Hierarchy

  • SyntheticsApiGetBrowserTestResultRequest

Index

Properties

Properties

publicId

publicId: string

The public ID of the browser test to which the target result belongs.

-

resultId

resultId: string
+

resultId

resultId: string

The ID of the result to get.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetGlobalVariableRequest.html b/interfaces/v1.SyntheticsApiGetGlobalVariableRequest.html index 77c0af5f96c..ac61f0f9517 100644 --- a/interfaces/v1.SyntheticsApiGetGlobalVariableRequest.html +++ b/interfaces/v1.SyntheticsApiGetGlobalVariableRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiGetGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetGlobalVariableRequest

Hierarchy

  • SyntheticsApiGetGlobalVariableRequest

Index

Properties

Properties

variableId

variableId: string
+SyntheticsApiGetGlobalVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetGlobalVariableRequest

Hierarchy

  • SyntheticsApiGetGlobalVariableRequest

Index

Properties

Properties

variableId

variableId: string

The ID of the global variable.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetPrivateLocationRequest.html b/interfaces/v1.SyntheticsApiGetPrivateLocationRequest.html index 997b8bd3cae..7fd07849877 100644 --- a/interfaces/v1.SyntheticsApiGetPrivateLocationRequest.html +++ b/interfaces/v1.SyntheticsApiGetPrivateLocationRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiGetPrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetPrivateLocationRequest

Hierarchy

  • SyntheticsApiGetPrivateLocationRequest

Index

Properties

Properties

locationId

locationId: string
+SyntheticsApiGetPrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetPrivateLocationRequest

Hierarchy

  • SyntheticsApiGetPrivateLocationRequest

Index

Properties

Properties

locationId

locationId: string

The ID of the private location.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetSyntheticsCIBatchRequest.html b/interfaces/v1.SyntheticsApiGetSyntheticsCIBatchRequest.html index 38e42765603..a4e4cfec488 100644 --- a/interfaces/v1.SyntheticsApiGetSyntheticsCIBatchRequest.html +++ b/interfaces/v1.SyntheticsApiGetSyntheticsCIBatchRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiGetSyntheticsCIBatchRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetSyntheticsCIBatchRequest

Hierarchy

  • SyntheticsApiGetSyntheticsCIBatchRequest

Index

Properties

Properties

batchId

batchId: string
+SyntheticsApiGetSyntheticsCIBatchRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetSyntheticsCIBatchRequest

Hierarchy

  • SyntheticsApiGetSyntheticsCIBatchRequest

Index

Properties

Properties

batchId

batchId: string

The ID of the batch.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiGetTestRequest.html b/interfaces/v1.SyntheticsApiGetTestRequest.html index db058fe3117..89a1448416b 100644 --- a/interfaces/v1.SyntheticsApiGetTestRequest.html +++ b/interfaces/v1.SyntheticsApiGetTestRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiGetTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetTestRequest

Hierarchy

  • SyntheticsApiGetTestRequest

Index

Properties

Properties

publicId

publicId: string
+SyntheticsApiGetTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiGetTestRequest

Hierarchy

  • SyntheticsApiGetTestRequest

Index

Properties

Properties

publicId

publicId: string

The public ID of the test to get details from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiTriggerCITestsRequest.html b/interfaces/v1.SyntheticsApiTriggerCITestsRequest.html index 0ce46c17eb6..dffc9d8b780 100644 --- a/interfaces/v1.SyntheticsApiTriggerCITestsRequest.html +++ b/interfaces/v1.SyntheticsApiTriggerCITestsRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiTriggerCITestsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiTriggerCITestsRequest

Hierarchy

  • SyntheticsApiTriggerCITestsRequest

Index

Properties

Properties

body

body: SyntheticsCITestBody
+SyntheticsApiTriggerCITestsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiTriggerCITestsRequest

Hierarchy

  • SyntheticsApiTriggerCITestsRequest

Index

Properties

Properties

body

body: SyntheticsCITestBody

Details of the test to trigger.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiTriggerTestsRequest.html b/interfaces/v1.SyntheticsApiTriggerTestsRequest.html index 124116a6c97..38ccbcbbf99 100644 --- a/interfaces/v1.SyntheticsApiTriggerTestsRequest.html +++ b/interfaces/v1.SyntheticsApiTriggerTestsRequest.html @@ -1,3 +1,3 @@ -SyntheticsApiTriggerTestsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiTriggerTestsRequest

Hierarchy

  • SyntheticsApiTriggerTestsRequest

Index

Properties

Properties

body

body: SyntheticsTriggerBody
+SyntheticsApiTriggerTestsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiTriggerTestsRequest

Hierarchy

  • SyntheticsApiTriggerTestsRequest

Index

Properties

Properties

body

body: SyntheticsTriggerBody

The identifiers of the tests to trigger.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiUpdateAPITestRequest.html b/interfaces/v1.SyntheticsApiUpdateAPITestRequest.html index 065fd542a92..5a58084885d 100644 --- a/interfaces/v1.SyntheticsApiUpdateAPITestRequest.html +++ b/interfaces/v1.SyntheticsApiUpdateAPITestRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiUpdateAPITestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdateAPITestRequest

Hierarchy

  • SyntheticsApiUpdateAPITestRequest

Index

Properties

Properties

body

body: SyntheticsAPITest
+SyntheticsApiUpdateAPITestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdateAPITestRequest

Hierarchy

  • SyntheticsApiUpdateAPITestRequest

Index

Properties

Properties

body

body: SyntheticsAPITest

New test details to be saved.

-

publicId

publicId: string
+

publicId

publicId: string

The public ID of the test to get details from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiUpdateBrowserTestRequest.html b/interfaces/v1.SyntheticsApiUpdateBrowserTestRequest.html index 8e1159de7f5..245766bd743 100644 --- a/interfaces/v1.SyntheticsApiUpdateBrowserTestRequest.html +++ b/interfaces/v1.SyntheticsApiUpdateBrowserTestRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiUpdateBrowserTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdateBrowserTestRequest

Hierarchy

  • SyntheticsApiUpdateBrowserTestRequest

Index

Properties

Properties

body

body: SyntheticsBrowserTest
+SyntheticsApiUpdateBrowserTestRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdateBrowserTestRequest

Hierarchy

  • SyntheticsApiUpdateBrowserTestRequest

Index

Properties

Properties

body

body: SyntheticsBrowserTest

New test details to be saved.

-

publicId

publicId: string
+

publicId

publicId: string

The public ID of the test to get details from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiUpdatePrivateLocationRequest.html b/interfaces/v1.SyntheticsApiUpdatePrivateLocationRequest.html index 7750e07aee8..150fc7ac188 100644 --- a/interfaces/v1.SyntheticsApiUpdatePrivateLocationRequest.html +++ b/interfaces/v1.SyntheticsApiUpdatePrivateLocationRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiUpdatePrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdatePrivateLocationRequest

Hierarchy

  • SyntheticsApiUpdatePrivateLocationRequest

Index

Properties

Properties

body

body: SyntheticsPrivateLocation
+SyntheticsApiUpdatePrivateLocationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdatePrivateLocationRequest

Hierarchy

  • SyntheticsApiUpdatePrivateLocationRequest

Index

Properties

Properties

body

body: SyntheticsPrivateLocation

Details of the private location to be updated.

-

locationId

locationId: string
+

locationId

locationId: string

The ID of the private location.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.SyntheticsApiUpdateTestPauseStatusRequest.html b/interfaces/v1.SyntheticsApiUpdateTestPauseStatusRequest.html index 3754b0962e3..cba7924a555 100644 --- a/interfaces/v1.SyntheticsApiUpdateTestPauseStatusRequest.html +++ b/interfaces/v1.SyntheticsApiUpdateTestPauseStatusRequest.html @@ -1,5 +1,5 @@ -SyntheticsApiUpdateTestPauseStatusRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdateTestPauseStatusRequest

Hierarchy

  • SyntheticsApiUpdateTestPauseStatusRequest

Index

Properties

Properties

body

body: SyntheticsUpdateTestPauseStatusPayload
+SyntheticsApiUpdateTestPauseStatusRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SyntheticsApiUpdateTestPauseStatusRequest

Hierarchy

  • SyntheticsApiUpdateTestPauseStatusRequest

Index

Properties

Properties

body

body: SyntheticsUpdateTestPauseStatusPayload

Status to set the given Synthetic test to.

-

publicId

publicId: string
+

publicId

publicId: string

The public ID of the Synthetic test to update.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.TagsApiCreateHostTagsRequest.html b/interfaces/v1.TagsApiCreateHostTagsRequest.html index 268a54e4552..6b4b5cc9491 100644 --- a/interfaces/v1.TagsApiCreateHostTagsRequest.html +++ b/interfaces/v1.TagsApiCreateHostTagsRequest.html @@ -1,7 +1,7 @@ -TagsApiCreateHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiCreateHostTagsRequest

Hierarchy

  • TagsApiCreateHostTagsRequest

Index

Properties

Properties

body

body: HostTags
+TagsApiCreateHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiCreateHostTagsRequest

Hierarchy

  • TagsApiCreateHostTagsRequest

Index

Properties

Properties

body

body: HostTags

Update host tags request body.

-

hostName

hostName: string
+

hostName

hostName: string

This endpoint allows you to add new tags to a host, optionally specifying where the tags came from.

-

Optional source

source?: string
+

Optional source

source?: string

The source of the tags. Complete list of source attribute values.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.TagsApiDeleteHostTagsRequest.html b/interfaces/v1.TagsApiDeleteHostTagsRequest.html index 7a3e349fdfd..de4dc9a7978 100644 --- a/interfaces/v1.TagsApiDeleteHostTagsRequest.html +++ b/interfaces/v1.TagsApiDeleteHostTagsRequest.html @@ -1,5 +1,5 @@ -TagsApiDeleteHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiDeleteHostTagsRequest

Hierarchy

  • TagsApiDeleteHostTagsRequest

Index

Properties

Properties

hostName

hostName: string
+TagsApiDeleteHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiDeleteHostTagsRequest

Hierarchy

  • TagsApiDeleteHostTagsRequest

Index

Properties

Properties

hostName

hostName: string

This endpoint allows you to remove all user-assigned tags for a single host.

-

Optional source

source?: string
+

Optional source

source?: string

The source of the tags (for example chef, puppet). Complete list of source attribute values.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.TagsApiGetHostTagsRequest.html b/interfaces/v1.TagsApiGetHostTagsRequest.html index f170a16f9ee..397520e8a1f 100644 --- a/interfaces/v1.TagsApiGetHostTagsRequest.html +++ b/interfaces/v1.TagsApiGetHostTagsRequest.html @@ -1,5 +1,5 @@ -TagsApiGetHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiGetHostTagsRequest

Hierarchy

  • TagsApiGetHostTagsRequest

Index

Properties

Properties

hostName

hostName: string
+TagsApiGetHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiGetHostTagsRequest

Hierarchy

  • TagsApiGetHostTagsRequest

Index

Properties

Properties

hostName

hostName: string

When specified, filters list of tags to those tags with the specified source.

-

Optional source

source?: string
+

Optional source

source?: string

Source to filter.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.TagsApiListHostTagsRequest.html b/interfaces/v1.TagsApiListHostTagsRequest.html index 01155d67291..a2e5103ccd0 100644 --- a/interfaces/v1.TagsApiListHostTagsRequest.html +++ b/interfaces/v1.TagsApiListHostTagsRequest.html @@ -1,3 +1,3 @@ -TagsApiListHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiListHostTagsRequest

Hierarchy

  • TagsApiListHostTagsRequest

Index

Properties

Properties

Optional source

source?: string
+TagsApiListHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiListHostTagsRequest

Hierarchy

  • TagsApiListHostTagsRequest

Index

Properties

Properties

Optional source

source?: string

When specified, filters host list to those tags with the specified source.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.TagsApiUpdateHostTagsRequest.html b/interfaces/v1.TagsApiUpdateHostTagsRequest.html index e16325ebaab..b54566ba934 100644 --- a/interfaces/v1.TagsApiUpdateHostTagsRequest.html +++ b/interfaces/v1.TagsApiUpdateHostTagsRequest.html @@ -1,7 +1,7 @@ -TagsApiUpdateHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiUpdateHostTagsRequest

Hierarchy

  • TagsApiUpdateHostTagsRequest

Index

Properties

Properties

body

body: HostTags
+TagsApiUpdateHostTagsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TagsApiUpdateHostTagsRequest

Hierarchy

  • TagsApiUpdateHostTagsRequest

Index

Properties

Properties

body

body: HostTags

Add tags to host

-

hostName

hostName: string
+

hostName

hostName: string

This endpoint allows you to update/replace all in an integration source with those supplied in the request.

-

Optional source

source?: string
+

Optional source

source?: string

The source of the tags (for example chef, puppet). Complete list of source attribute values

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.TokenProvider.html b/interfaces/v1.TokenProvider.html index b80e14bfccf..709b51223ca 100644 --- a/interfaces/v1.TokenProvider.html +++ b/interfaces/v1.TokenProvider.html @@ -1 +1 @@ -TokenProvider | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenProvider

Hierarchy

  • TokenProvider

Index

Methods

Methods

getToken

  • getToken(): string | Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +TokenProvider | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenProvider

Hierarchy

  • TokenProvider

Index

Methods

Methods

getToken

  • getToken(): string | Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetDailyCustomReportsRequest.html b/interfaces/v1.UsageMeteringApiGetDailyCustomReportsRequest.html index afe8f266f81..7e10606c0f1 100644 --- a/interfaces/v1.UsageMeteringApiGetDailyCustomReportsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetDailyCustomReportsRequest.html @@ -1,9 +1,9 @@ -UsageMeteringApiGetDailyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetDailyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetDailyCustomReportsRequest

Index

Properties

Properties

Optional pageNumber

pageNumber?: number
+UsageMeteringApiGetDailyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetDailyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetDailyCustomReportsRequest

Index

Properties

Properties

Optional pageNumber

pageNumber?: number

The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

The number of files to return in the response. `[default=60]`.

-

Optional sort

sort?: UsageSort
+

Optional sort

sort?: UsageSort

The field to sort by: `[computed_on, size, start_date, end_date]`.

-

Optional sortDir

sortDir?: UsageSortDirection
+

Optional sortDir

sortDir?: UsageSortDirection

The direction to sort by: `[desc, asc]`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetHourlyUsageAttributionRequest.html b/interfaces/v1.UsageMeteringApiGetHourlyUsageAttributionRequest.html index 651eff2c77f..73c49174e1f 100644 --- a/interfaces/v1.UsageMeteringApiGetHourlyUsageAttributionRequest.html +++ b/interfaces/v1.UsageMeteringApiGetHourlyUsageAttributionRequest.html @@ -1,11 +1,11 @@ -UsageMeteringApiGetHourlyUsageAttributionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetHourlyUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetHourlyUsageAttributionRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetHourlyUsageAttributionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetHourlyUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetHourlyUsageAttributionRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

Optional nextRecordId

nextRecordId?: string
+

Optional nextRecordId

nextRecordId?: string

List following results with a next_record_id provided in the previous query.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

-

Optional tagBreakdownKeys

tagBreakdownKeys?: string
+

Optional tagBreakdownKeys

tagBreakdownKeys?: string

Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.

-

usageType

usageType: HourlyUsageAttributionUsageType
+

usageType

usageType: HourlyUsageAttributionUsageType

Usage type to retrieve.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetIncidentManagementRequest.html b/interfaces/v1.UsageMeteringApiGetIncidentManagementRequest.html index 6ca767d6fdf..65b18c6e866 100644 --- a/interfaces/v1.UsageMeteringApiGetIncidentManagementRequest.html +++ b/interfaces/v1.UsageMeteringApiGetIncidentManagementRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetIncidentManagementRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetIncidentManagementRequest

Hierarchy

  • UsageMeteringApiGetIncidentManagementRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetIncidentManagementRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetIncidentManagementRequest

Hierarchy

  • UsageMeteringApiGetIncidentManagementRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetIngestedSpansRequest.html b/interfaces/v1.UsageMeteringApiGetIngestedSpansRequest.html index 983266e7e90..cfa3c8b8412 100644 --- a/interfaces/v1.UsageMeteringApiGetIngestedSpansRequest.html +++ b/interfaces/v1.UsageMeteringApiGetIngestedSpansRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetIngestedSpansRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetIngestedSpansRequest

Hierarchy

  • UsageMeteringApiGetIngestedSpansRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetIngestedSpansRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetIngestedSpansRequest

Hierarchy

  • UsageMeteringApiGetIngestedSpansRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetMonthlyCustomReportsRequest.html b/interfaces/v1.UsageMeteringApiGetMonthlyCustomReportsRequest.html index d6931381079..75847dc6ae6 100644 --- a/interfaces/v1.UsageMeteringApiGetMonthlyCustomReportsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetMonthlyCustomReportsRequest.html @@ -1,9 +1,9 @@ -UsageMeteringApiGetMonthlyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetMonthlyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetMonthlyCustomReportsRequest

Index

Properties

Properties

Optional pageNumber

pageNumber?: number
+UsageMeteringApiGetMonthlyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetMonthlyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetMonthlyCustomReportsRequest

Index

Properties

Properties

Optional pageNumber

pageNumber?: number

The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

The number of files to return in the response `[default=60].`

-

Optional sort

sort?: UsageSort
+

Optional sort

sort?: UsageSort

The field to sort by: `[computed_on, size, start_date, end_date]`.

-

Optional sortDir

sortDir?: UsageSortDirection
+

Optional sortDir

sortDir?: UsageSortDirection

The direction to sort by: `[desc, asc]`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetMonthlyUsageAttributionRequest.html b/interfaces/v1.UsageMeteringApiGetMonthlyUsageAttributionRequest.html index 1cf86d5a586..a30a94059ae 100644 --- a/interfaces/v1.UsageMeteringApiGetMonthlyUsageAttributionRequest.html +++ b/interfaces/v1.UsageMeteringApiGetMonthlyUsageAttributionRequest.html @@ -1,15 +1,15 @@ -UsageMeteringApiGetMonthlyUsageAttributionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetMonthlyUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetMonthlyUsageAttributionRequest

Index

Properties

Properties

Optional endMonth

endMonth?: Date
+UsageMeteringApiGetMonthlyUsageAttributionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetMonthlyUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetMonthlyUsageAttributionRequest

Index

Properties

Properties

Optional endMonth

endMonth?: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month.

-

fields

fields: MonthlyUsageAttributionSupportedMetrics
+

fields

fields: MonthlyUsageAttributionSupportedMetrics

Comma-separated list of usage types to return, or `*` for all usage types.

-

Optional nextRecordId

nextRecordId?: string
+

Optional nextRecordId

nextRecordId?: string

List following results with a next_record_id provided in the previous query.

-

Optional sortDirection

sortDirection?: UsageSortDirection
+

Optional sortDirection

sortDirection?: UsageSortDirection

The direction to sort by: `[desc, asc]`.

-

Optional sortName

sortName?: MonthlyUsageAttributionSupportedMetrics
+

Optional sortName

sortName?: MonthlyUsageAttributionSupportedMetrics

The field to sort by.

-

startMonth

startMonth: Date
+

startMonth

startMonth: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.

-

Optional tagBreakdownKeys

tagBreakdownKeys?: string
+

Optional tagBreakdownKeys

tagBreakdownKeys?: string

Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetSpecifiedDailyCustomReportsRequest.html b/interfaces/v1.UsageMeteringApiGetSpecifiedDailyCustomReportsRequest.html index 82514bcd28e..8d1ca045043 100644 --- a/interfaces/v1.UsageMeteringApiGetSpecifiedDailyCustomReportsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetSpecifiedDailyCustomReportsRequest.html @@ -1,3 +1,3 @@ -UsageMeteringApiGetSpecifiedDailyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetSpecifiedDailyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetSpecifiedDailyCustomReportsRequest

Index

Properties

Properties

reportId

reportId: string
+UsageMeteringApiGetSpecifiedDailyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetSpecifiedDailyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetSpecifiedDailyCustomReportsRequest

Index

Properties

Properties

reportId

reportId: string

Date of the report in the format `YYYY-MM-DD`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest.html b/interfaces/v1.UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest.html index e295a10ca5e..b523814ad53 100644 --- a/interfaces/v1.UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest.html @@ -1,3 +1,3 @@ -UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest

Index

Properties

Properties

reportId

reportId: string
+UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest

Hierarchy

  • UsageMeteringApiGetSpecifiedMonthlyCustomReportsRequest

Index

Properties

Properties

reportId

reportId: string

Date of the report in the format `YYYY-MM-DD`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageAnalyzedLogsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageAnalyzedLogsRequest.html index 20314db0efc..c58f523f02a 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageAnalyzedLogsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageAnalyzedLogsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageAnalyzedLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageAnalyzedLogsRequest

Hierarchy

  • UsageMeteringApiGetUsageAnalyzedLogsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageAnalyzedLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageAnalyzedLogsRequest

Hierarchy

  • UsageMeteringApiGetUsageAnalyzedLogsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageAttributionRequest.html b/interfaces/v1.UsageMeteringApiGetUsageAttributionRequest.html index 4a8f0be6db6..2f6bb0f2cb6 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageAttributionRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageAttributionRequest.html @@ -1,17 +1,17 @@ -UsageMeteringApiGetUsageAttributionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetUsageAttributionRequest

Index

Properties

Properties

Optional endMonth

endMonth?: Date
+UsageMeteringApiGetUsageAttributionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageAttributionRequest

Hierarchy

  • UsageMeteringApiGetUsageAttributionRequest

Index

Properties

Properties

Optional endMonth

endMonth?: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month.

-

fields

fields: UsageAttributionSupportedMetrics
+

fields

fields: UsageAttributionSupportedMetrics

Comma-separated list of usage types to return, or `*` for all usage types.

-

Optional includeDescendants

includeDescendants?: boolean
+

Optional includeDescendants

includeDescendants?: boolean

Include child org usage in the response. Defaults to false.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Maximum number of records to be returned.

-

Optional offset

offset?: number
+

Optional offset

offset?: number

Number of records to skip before beginning to return.

-

Optional sortDirection

sortDirection?: UsageSortDirection
+

Optional sortDirection

sortDirection?: UsageSortDirection

The direction to sort by: `[desc, asc]`.

-

Optional sortName

sortName?: UsageAttributionSort
+

Optional sortName

sortName?: UsageAttributionSort

The field to sort by.

-

startMonth

startMonth: Date
+

startMonth

startMonth: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageAuditLogsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageAuditLogsRequest.html index 29e517cefe4..50ad8f526ef 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageAuditLogsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageAuditLogsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageAuditLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageAuditLogsRequest

Hierarchy

  • UsageMeteringApiGetUsageAuditLogsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageAuditLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageAuditLogsRequest

Hierarchy

  • UsageMeteringApiGetUsageAuditLogsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageBillableSummaryRequest.html b/interfaces/v1.UsageMeteringApiGetUsageBillableSummaryRequest.html index 2212f9194ed..db27befbc01 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageBillableSummaryRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageBillableSummaryRequest.html @@ -1,3 +1,3 @@ -UsageMeteringApiGetUsageBillableSummaryRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageBillableSummaryRequest

Hierarchy

  • UsageMeteringApiGetUsageBillableSummaryRequest

Index

Properties

Properties

Optional month

month?: Date
+UsageMeteringApiGetUsageBillableSummaryRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageBillableSummaryRequest

Hierarchy

  • UsageMeteringApiGetUsageBillableSummaryRequest

Index

Properties

Properties

Optional month

month?: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageCWSRequest.html b/interfaces/v1.UsageMeteringApiGetUsageCWSRequest.html index 93fbd5f5aac..6eeb4a164d0 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageCWSRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageCWSRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageCWSRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageCWSRequest

Hierarchy

  • UsageMeteringApiGetUsageCWSRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageCWSRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageCWSRequest

Hierarchy

  • UsageMeteringApiGetUsageCWSRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest.html b/interfaces/v1.UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest.html index 38cfa3b9db1..c7341be1f6c 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest

Hierarchy

  • UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest

Hierarchy

  • UsageMeteringApiGetUsageCloudSecurityPostureManagementRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageDBMRequest.html b/interfaces/v1.UsageMeteringApiGetUsageDBMRequest.html index cbc3f424712..4f91d467816 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageDBMRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageDBMRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageDBMRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageDBMRequest

Hierarchy

  • UsageMeteringApiGetUsageDBMRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageDBMRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageDBMRequest

Hierarchy

  • UsageMeteringApiGetUsageDBMRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageFargateRequest.html b/interfaces/v1.UsageMeteringApiGetUsageFargateRequest.html index 1d41797faf2..1496710c047 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageFargateRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageFargateRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageFargateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageFargateRequest

Hierarchy

  • UsageMeteringApiGetUsageFargateRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageFargateRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageFargateRequest

Hierarchy

  • UsageMeteringApiGetUsageFargateRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageHostsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageHostsRequest.html index 11ec89161da..38e0be7b883 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageHostsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageHostsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageHostsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageHostsRequest

Hierarchy

  • UsageMeteringApiGetUsageHostsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageHostsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageHostsRequest

Hierarchy

  • UsageMeteringApiGetUsageHostsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageIndexedSpansRequest.html b/interfaces/v1.UsageMeteringApiGetUsageIndexedSpansRequest.html index 72136658465..1590c61bb69 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageIndexedSpansRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageIndexedSpansRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageIndexedSpansRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageIndexedSpansRequest

Hierarchy

  • UsageMeteringApiGetUsageIndexedSpansRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageIndexedSpansRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageIndexedSpansRequest

Hierarchy

  • UsageMeteringApiGetUsageIndexedSpansRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageInternetOfThingsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageInternetOfThingsRequest.html index c301d9296f4..192aa6c55a1 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageInternetOfThingsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageInternetOfThingsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageInternetOfThingsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageInternetOfThingsRequest

Hierarchy

  • UsageMeteringApiGetUsageInternetOfThingsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageInternetOfThingsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageInternetOfThingsRequest

Hierarchy

  • UsageMeteringApiGetUsageInternetOfThingsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageLambdaRequest.html b/interfaces/v1.UsageMeteringApiGetUsageLambdaRequest.html index ddc41ed6bfb..6e1d114378f 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageLambdaRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageLambdaRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageLambdaRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLambdaRequest

Hierarchy

  • UsageMeteringApiGetUsageLambdaRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageLambdaRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLambdaRequest

Hierarchy

  • UsageMeteringApiGetUsageLambdaRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageLogsByIndexRequest.html b/interfaces/v1.UsageMeteringApiGetUsageLogsByIndexRequest.html index af497d60e16..91fb2608e48 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageLogsByIndexRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageLogsByIndexRequest.html @@ -1,7 +1,7 @@ -UsageMeteringApiGetUsageLogsByIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLogsByIndexRequest

Hierarchy

  • UsageMeteringApiGetUsageLogsByIndexRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageLogsByIndexRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLogsByIndexRequest

Hierarchy

  • UsageMeteringApiGetUsageLogsByIndexRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

Optional indexName

indexName?: string[]
+

Optional indexName

indexName?: string[]

Comma-separated list of log index names.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageLogsByRetentionRequest.html b/interfaces/v1.UsageMeteringApiGetUsageLogsByRetentionRequest.html index 39d3cf27e09..856f0ac0576 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageLogsByRetentionRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageLogsByRetentionRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageLogsByRetentionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLogsByRetentionRequest

Hierarchy

  • UsageMeteringApiGetUsageLogsByRetentionRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageLogsByRetentionRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLogsByRetentionRequest

Hierarchy

  • UsageMeteringApiGetUsageLogsByRetentionRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageLogsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageLogsRequest.html index e4de84d4a59..a1514ef07d3 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageLogsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageLogsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLogsRequest

Hierarchy

  • UsageMeteringApiGetUsageLogsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageLogsRequest

Hierarchy

  • UsageMeteringApiGetUsageLogsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageNetworkFlowsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageNetworkFlowsRequest.html index c263b80ed81..fa9dd9cfc14 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageNetworkFlowsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageNetworkFlowsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageNetworkFlowsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageNetworkFlowsRequest

Hierarchy

  • UsageMeteringApiGetUsageNetworkFlowsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageNetworkFlowsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageNetworkFlowsRequest

Hierarchy

  • UsageMeteringApiGetUsageNetworkFlowsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageNetworkHostsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageNetworkHostsRequest.html index ebc0fe58fd9..0c4be8f856f 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageNetworkHostsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageNetworkHostsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageNetworkHostsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageNetworkHostsRequest

Hierarchy

  • UsageMeteringApiGetUsageNetworkHostsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageNetworkHostsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageNetworkHostsRequest

Hierarchy

  • UsageMeteringApiGetUsageNetworkHostsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageProfilingRequest.html b/interfaces/v1.UsageMeteringApiGetUsageProfilingRequest.html index 48a8e2d4ec2..cef9f3c6a89 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageProfilingRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageProfilingRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageProfilingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageProfilingRequest

Hierarchy

  • UsageMeteringApiGetUsageProfilingRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageProfilingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageProfilingRequest

Hierarchy

  • UsageMeteringApiGetUsageProfilingRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageRumSessionsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageRumSessionsRequest.html index 1ddb63eb4b1..9c8d96d6958 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageRumSessionsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageRumSessionsRequest.html @@ -1,7 +1,7 @@ -UsageMeteringApiGetUsageRumSessionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageRumSessionsRequest

Hierarchy

  • UsageMeteringApiGetUsageRumSessionsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageRumSessionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageRumSessionsRequest

Hierarchy

  • UsageMeteringApiGetUsageRumSessionsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

-

Optional type

type?: string
+

Optional type

type?: string

RUM type: `[browser, mobile]`. Defaults to `browser`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageRumUnitsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageRumUnitsRequest.html index 1a37f69cdc9..580eb9302b0 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageRumUnitsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageRumUnitsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageRumUnitsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageRumUnitsRequest

Hierarchy

  • UsageMeteringApiGetUsageRumUnitsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageRumUnitsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageRumUnitsRequest

Hierarchy

  • UsageMeteringApiGetUsageRumUnitsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageSDSRequest.html b/interfaces/v1.UsageMeteringApiGetUsageSDSRequest.html index 0788a9c3d5f..9f5299564a0 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageSDSRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageSDSRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageSDSRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSDSRequest

Hierarchy

  • UsageMeteringApiGetUsageSDSRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageSDSRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSDSRequest

Hierarchy

  • UsageMeteringApiGetUsageSDSRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageSNMPRequest.html b/interfaces/v1.UsageMeteringApiGetUsageSNMPRequest.html index ce88cf28127..c864a877719 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageSNMPRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageSNMPRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageSNMPRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSNMPRequest

Hierarchy

  • UsageMeteringApiGetUsageSNMPRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageSNMPRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSNMPRequest

Hierarchy

  • UsageMeteringApiGetUsageSNMPRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageSummaryRequest.html b/interfaces/v1.UsageMeteringApiGetUsageSummaryRequest.html index 77a0f7814aa..c0ca3f79b36 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageSummaryRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageSummaryRequest.html @@ -1,7 +1,7 @@ -UsageMeteringApiGetUsageSummaryRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSummaryRequest

Hierarchy

  • UsageMeteringApiGetUsageSummaryRequest

Index

Properties

Properties

Optional endMonth

endMonth?: Date
+UsageMeteringApiGetUsageSummaryRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSummaryRequest

Hierarchy

  • UsageMeteringApiGetUsageSummaryRequest

Index

Properties

Properties

Optional endMonth

endMonth?: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month.

-

Optional includeOrgDetails

includeOrgDetails?: boolean
+

Optional includeOrgDetails

includeOrgDetails?: boolean

Include usage summaries for each sub-org.

-

startMonth

startMonth: Date
+

startMonth

startMonth: Date

Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageSyntheticsAPIRequest.html b/interfaces/v1.UsageMeteringApiGetUsageSyntheticsAPIRequest.html index 7b95b6e659b..876ab42016f 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageSyntheticsAPIRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageSyntheticsAPIRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageSyntheticsAPIRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSyntheticsAPIRequest

Hierarchy

  • UsageMeteringApiGetUsageSyntheticsAPIRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageSyntheticsAPIRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSyntheticsAPIRequest

Hierarchy

  • UsageMeteringApiGetUsageSyntheticsAPIRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageSyntheticsBrowserRequest.html b/interfaces/v1.UsageMeteringApiGetUsageSyntheticsBrowserRequest.html index e7979a9a954..3775e49b3ac 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageSyntheticsBrowserRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageSyntheticsBrowserRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageSyntheticsBrowserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSyntheticsBrowserRequest

Hierarchy

  • UsageMeteringApiGetUsageSyntheticsBrowserRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageSyntheticsBrowserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSyntheticsBrowserRequest

Hierarchy

  • UsageMeteringApiGetUsageSyntheticsBrowserRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageSyntheticsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageSyntheticsRequest.html index 98a3de23b3f..8aa473906a8 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageSyntheticsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageSyntheticsRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageSyntheticsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSyntheticsRequest

Hierarchy

  • UsageMeteringApiGetUsageSyntheticsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageSyntheticsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageSyntheticsRequest

Hierarchy

  • UsageMeteringApiGetUsageSyntheticsRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageTimeseriesRequest.html b/interfaces/v1.UsageMeteringApiGetUsageTimeseriesRequest.html index daee1e8b105..b0e1f5db087 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageTimeseriesRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageTimeseriesRequest.html @@ -1,5 +1,5 @@ -UsageMeteringApiGetUsageTimeseriesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageTimeseriesRequest

Hierarchy

  • UsageMeteringApiGetUsageTimeseriesRequest

Index

Properties

Properties

Optional endHr

endHr?: Date
+UsageMeteringApiGetUsageTimeseriesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageTimeseriesRequest

Hierarchy

  • UsageMeteringApiGetUsageTimeseriesRequest

Index

Properties

Properties

Optional endHr

endHr?: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending before this hour.

-

startHr

startHr: Date
+

startHr

startHr: Date

Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsageMeteringApiGetUsageTopAvgMetricsRequest.html b/interfaces/v1.UsageMeteringApiGetUsageTopAvgMetricsRequest.html index 372391cad3c..1cc6ff640c9 100644 --- a/interfaces/v1.UsageMeteringApiGetUsageTopAvgMetricsRequest.html +++ b/interfaces/v1.UsageMeteringApiGetUsageTopAvgMetricsRequest.html @@ -1,11 +1,11 @@ -UsageMeteringApiGetUsageTopAvgMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageTopAvgMetricsRequest

Hierarchy

  • UsageMeteringApiGetUsageTopAvgMetricsRequest

Index

Properties

Properties

Optional day

day?: Date
+UsageMeteringApiGetUsageTopAvgMetricsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsageMeteringApiGetUsageTopAvgMetricsRequest

Hierarchy

  • UsageMeteringApiGetUsageTopAvgMetricsRequest

Index

Properties

Properties

Optional day

day?: Date

Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified.

-

Optional month

month?: Date
+

Optional month

month?: Date

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)

-

Optional names

names?: string[]
+

Optional names

names?: string[]

Comma-separated list of metric names.

-

Optional nextRecordId

nextRecordId?: string
+

Optional nextRecordId

nextRecordId?: string

List following results with a next_record_id provided in the previous query.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsersApiCreateUserRequest.html b/interfaces/v1.UsersApiCreateUserRequest.html index 6c7db2b1be0..25fe568c2c7 100644 --- a/interfaces/v1.UsersApiCreateUserRequest.html +++ b/interfaces/v1.UsersApiCreateUserRequest.html @@ -1,3 +1,3 @@ -UsersApiCreateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiCreateUserRequest

Hierarchy

  • UsersApiCreateUserRequest

Index

Properties

Properties

body

body: v1.User
+UsersApiCreateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiCreateUserRequest

Hierarchy

  • UsersApiCreateUserRequest

Index

Properties

Properties

body

body: v1.User

User object that needs to be created.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsersApiDisableUserRequest.html b/interfaces/v1.UsersApiDisableUserRequest.html index 49942e7ecaa..0afb54d7425 100644 --- a/interfaces/v1.UsersApiDisableUserRequest.html +++ b/interfaces/v1.UsersApiDisableUserRequest.html @@ -1,3 +1,3 @@ -UsersApiDisableUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiDisableUserRequest

Hierarchy

  • UsersApiDisableUserRequest

Index

Properties

Properties

userHandle

userHandle: string
+UsersApiDisableUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiDisableUserRequest

Hierarchy

  • UsersApiDisableUserRequest

Index

Properties

Properties

userHandle

userHandle: string

The handle of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsersApiGetUserRequest.html b/interfaces/v1.UsersApiGetUserRequest.html index 1307f4a5370..668e1eaf6db 100644 --- a/interfaces/v1.UsersApiGetUserRequest.html +++ b/interfaces/v1.UsersApiGetUserRequest.html @@ -1,3 +1,3 @@ -UsersApiGetUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiGetUserRequest

Hierarchy

  • UsersApiGetUserRequest

Index

Properties

Properties

userHandle

userHandle: string
+UsersApiGetUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiGetUserRequest

Hierarchy

  • UsersApiGetUserRequest

Index

Properties

Properties

userHandle

userHandle: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.UsersApiUpdateUserRequest.html b/interfaces/v1.UsersApiUpdateUserRequest.html index 3a80e0c0cdd..480f7777434 100644 --- a/interfaces/v1.UsersApiUpdateUserRequest.html +++ b/interfaces/v1.UsersApiUpdateUserRequest.html @@ -1,5 +1,5 @@ -UsersApiUpdateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiUpdateUserRequest

Hierarchy

  • UsersApiUpdateUserRequest

Index

Properties

Properties

body

body: v1.User
+UsersApiUpdateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiUpdateUserRequest

Hierarchy

  • UsersApiUpdateUserRequest

Index

Properties

Properties

body

body: v1.User

Description of the update.

-

userHandle

userHandle: string
+

userHandle

userHandle: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest.html b/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest.html index 858d47dab66..b8a7489250f 100644 --- a/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest.html @@ -1,3 +1,3 @@ -WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

body

body: WebhooksIntegrationCustomVariable
+WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

body

body: WebhooksIntegrationCustomVariable

Define a custom variable request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationRequest.html b/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationRequest.html index 0176d0eb0fb..2c573569a29 100644 --- a/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiCreateWebhooksIntegrationRequest.html @@ -1,3 +1,3 @@ -WebhooksIntegrationApiCreateWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiCreateWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiCreateWebhooksIntegrationRequest

Index

Properties

Properties

body

body: WebhooksIntegration
+WebhooksIntegrationApiCreateWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiCreateWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiCreateWebhooksIntegrationRequest

Index

Properties

Properties

body

body: WebhooksIntegration

Create a webhooks integration request body.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest.html b/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest.html index c16a9f63b14..8ff80f191ed 100644 --- a/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest.html @@ -1,3 +1,3 @@ -WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

customVariableName

customVariableName: string
+WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

customVariableName

customVariableName: string

The name of the custom variable.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationRequest.html b/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationRequest.html index 2ff6d29b37a..5615ae59f1f 100644 --- a/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiDeleteWebhooksIntegrationRequest.html @@ -1,3 +1,3 @@ -WebhooksIntegrationApiDeleteWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiDeleteWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiDeleteWebhooksIntegrationRequest

Index

Properties

Properties

webhookName

webhookName: string
+WebhooksIntegrationApiDeleteWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiDeleteWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiDeleteWebhooksIntegrationRequest

Index

Properties

Properties

webhookName

webhookName: string

The name of the webhook.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest.html b/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest.html index 88f35502a3a..813e88a1f66 100644 --- a/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest.html @@ -1,3 +1,3 @@ -WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

customVariableName

customVariableName: string
+WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

customVariableName

customVariableName: string

The name of the custom variable.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationRequest.html b/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationRequest.html index 0be9e4b260d..bc64e87cdb9 100644 --- a/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiGetWebhooksIntegrationRequest.html @@ -1,3 +1,3 @@ -WebhooksIntegrationApiGetWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiGetWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiGetWebhooksIntegrationRequest

Index

Properties

Properties

webhookName

webhookName: string
+WebhooksIntegrationApiGetWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiGetWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiGetWebhooksIntegrationRequest

Index

Properties

Properties

webhookName

webhookName: string

The name of the webhook.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest.html b/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest.html index d3dafad9dc7..a0fa9c4b06b 100644 --- a/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest.html @@ -1,5 +1,5 @@ -WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

body

body: WebhooksIntegrationCustomVariableUpdateRequest
+WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest

Hierarchy

  • WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest

Index

Properties

Properties

body

body: WebhooksIntegrationCustomVariableUpdateRequest

Update an existing custom variable request body.

-

customVariableName

customVariableName: string
+

customVariableName

customVariableName: string

The name of the custom variable.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationRequest.html b/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationRequest.html index 3c1e9678625..d020f8aa477 100644 --- a/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationRequest.html +++ b/interfaces/v1.WebhooksIntegrationApiUpdateWebhooksIntegrationRequest.html @@ -1,5 +1,5 @@ -WebhooksIntegrationApiUpdateWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiUpdateWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiUpdateWebhooksIntegrationRequest

Index

Properties

Properties

body

body: WebhooksIntegrationUpdateRequest
+WebhooksIntegrationApiUpdateWebhooksIntegrationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebhooksIntegrationApiUpdateWebhooksIntegrationRequest

Hierarchy

  • WebhooksIntegrationApiUpdateWebhooksIntegrationRequest

Index

Properties

Properties

body

body: WebhooksIntegrationUpdateRequest

Update an existing Datadog-Webhooks integration.

-

webhookName

webhookName: string
+

webhookName

webhookName: string

The name of the webhook.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.AbortSignal.html b/interfaces/v2.AbortSignal.html index 02aed136fb0..0b1705a5e07 100644 --- a/interfaces/v2.AbortSignal.html +++ b/interfaces/v2.AbortSignal.html @@ -1,3 +1,3 @@ AbortSignal | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AbortSignal

Interface for aborting fetch requests.

-

Hierarchy

  • AbortSignal

Index

Properties

Methods

Properties

aborted

aborted: boolean

onabort

onabort: null | ((event: any) => void)

Methods

addEventListener

  • addEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean; once?: boolean; passive?: boolean }): void

  • Parameters

    • type: "abort"
    • listener: (event: any) => any
        • (event: any): any

        • Parameters

          • event: any

          Returns any

    • Optional options: boolean | { capture?: boolean; once?: boolean; passive?: boolean }

    Returns void

dispatchEvent

  • dispatchEvent(event: any): boolean

removeEventListener

  • removeEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean }): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AbortSignal

Index

Properties

Methods

Properties

aborted

aborted: boolean

onabort

onabort: null | ((event: any) => void)

Methods

addEventListener

  • addEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean; once?: boolean; passive?: boolean }): void

  • Parameters

    • type: "abort"
    • listener: (event: any) => any
        • (event: any): any

        • Parameters

          • event: any

          Returns any

    • Optional options: boolean | { capture?: boolean; once?: boolean; passive?: boolean }

    Returns void

dispatchEvent

  • dispatchEvent(event: any): boolean

removeEventListener

  • removeEventListener(type: "abort", listener: (event: any) => any, options?: boolean | { capture?: boolean }): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.AuthNMappingsApiCreateAuthNMappingRequest.html b/interfaces/v2.AuthNMappingsApiCreateAuthNMappingRequest.html index aaf91c4fdd4..6ab357d635d 100644 --- a/interfaces/v2.AuthNMappingsApiCreateAuthNMappingRequest.html +++ b/interfaces/v2.AuthNMappingsApiCreateAuthNMappingRequest.html @@ -1 +1 @@ -AuthNMappingsApiCreateAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiCreateAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiCreateAuthNMappingRequest

Index

Properties

Properties

body

body: AuthNMappingCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +AuthNMappingsApiCreateAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiCreateAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiCreateAuthNMappingRequest

Index

Properties

Properties

body

body: AuthNMappingCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.AuthNMappingsApiDeleteAuthNMappingRequest.html b/interfaces/v2.AuthNMappingsApiDeleteAuthNMappingRequest.html index 5fee2f0f1dd..bd37622f541 100644 --- a/interfaces/v2.AuthNMappingsApiDeleteAuthNMappingRequest.html +++ b/interfaces/v2.AuthNMappingsApiDeleteAuthNMappingRequest.html @@ -1,3 +1,3 @@ -AuthNMappingsApiDeleteAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiDeleteAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiDeleteAuthNMappingRequest

Index

Properties

Properties

authnMappingId

authnMappingId: string
+AuthNMappingsApiDeleteAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiDeleteAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiDeleteAuthNMappingRequest

Index

Properties

Properties

authnMappingId

authnMappingId: string

The UUID of the AuthN Mapping.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.AuthNMappingsApiGetAuthNMappingRequest.html b/interfaces/v2.AuthNMappingsApiGetAuthNMappingRequest.html index a5884f77fdb..063d218b830 100644 --- a/interfaces/v2.AuthNMappingsApiGetAuthNMappingRequest.html +++ b/interfaces/v2.AuthNMappingsApiGetAuthNMappingRequest.html @@ -1,3 +1,3 @@ -AuthNMappingsApiGetAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiGetAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiGetAuthNMappingRequest

Index

Properties

Properties

authnMappingId

authnMappingId: string
+AuthNMappingsApiGetAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiGetAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiGetAuthNMappingRequest

Index

Properties

Properties

authnMappingId

authnMappingId: string

The UUID of the AuthN Mapping.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.AuthNMappingsApiListAuthNMappingsRequest.html b/interfaces/v2.AuthNMappingsApiListAuthNMappingsRequest.html index 8dd67d1d977..2ad73909916 100644 --- a/interfaces/v2.AuthNMappingsApiListAuthNMappingsRequest.html +++ b/interfaces/v2.AuthNMappingsApiListAuthNMappingsRequest.html @@ -1,11 +1,11 @@ -AuthNMappingsApiListAuthNMappingsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiListAuthNMappingsRequest

Hierarchy

  • AuthNMappingsApiListAuthNMappingsRequest

Index

Properties

Properties

Optional filter

filter?: string
+AuthNMappingsApiListAuthNMappingsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiListAuthNMappingsRequest

Hierarchy

  • AuthNMappingsApiListAuthNMappingsRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter all mappings by the given string.

-

Optional include

include?: string[]
+

Optional include

include?: string[]

Include additional information in the response.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

Optional sort

sort?: AuthNMappingsSort
+

Optional sort

sort?: AuthNMappingsSort

Sort AuthN Mappings depending on the given field.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.AuthNMappingsApiUpdateAuthNMappingRequest.html b/interfaces/v2.AuthNMappingsApiUpdateAuthNMappingRequest.html index 4e4679d0c07..a88925f398a 100644 --- a/interfaces/v2.AuthNMappingsApiUpdateAuthNMappingRequest.html +++ b/interfaces/v2.AuthNMappingsApiUpdateAuthNMappingRequest.html @@ -1,3 +1,3 @@ -AuthNMappingsApiUpdateAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiUpdateAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiUpdateAuthNMappingRequest

Index

Properties

Properties

authnMappingId

authnMappingId: string
+AuthNMappingsApiUpdateAuthNMappingRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthNMappingsApiUpdateAuthNMappingRequest

Hierarchy

  • AuthNMappingsApiUpdateAuthNMappingRequest

Index

Properties

Properties

authnMappingId

authnMappingId: string

The UUID of the AuthN Mapping.

-

body

body: AuthNMappingUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

body

body: AuthNMappingUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest.html b/interfaces/v2.CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest.html index 679c6543f01..79a65a0e5ed 100644 --- a/interfaces/v2.CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest.html +++ b/interfaces/v2.CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest.html @@ -1,3 +1,3 @@ -CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

body

body: CloudWorkloadSecurityAgentRuleCreateRequest
+CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiCreateCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

body

body: CloudWorkloadSecurityAgentRuleCreateRequest

The definition of the new Agent rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest.html b/interfaces/v2.CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest.html index 8058295dde9..a5c8236b469 100644 --- a/interfaces/v2.CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest.html +++ b/interfaces/v2.CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest.html @@ -1,3 +1,3 @@ -CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

agentRuleId

agentRuleId: string
+CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiDeleteCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

agentRuleId

agentRuleId: string

The ID of the Agent rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest.html b/interfaces/v2.CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest.html index ad3b02e9913..6d89eed9c75 100644 --- a/interfaces/v2.CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest.html +++ b/interfaces/v2.CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest.html @@ -1,3 +1,3 @@ -CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

agentRuleId

agentRuleId: string
+CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiGetCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

agentRuleId

agentRuleId: string

The ID of the Agent rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest.html b/interfaces/v2.CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest.html index c11237c81ac..6c602601e1d 100644 --- a/interfaces/v2.CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest.html +++ b/interfaces/v2.CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest.html @@ -1,5 +1,5 @@ -CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

agentRuleId

agentRuleId: string
+CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest

Hierarchy

  • CloudWorkloadSecurityApiUpdateCloudWorkloadSecurityAgentRuleRequest

Index

Properties

Properties

agentRuleId

agentRuleId: string

The ID of the Agent rule.

-

body

body: CloudWorkloadSecurityAgentRuleUpdateRequest
+

body

body: CloudWorkloadSecurityAgentRuleUpdateRequest

New definition of the Agent rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.Configuration.html b/interfaces/v2.Configuration.html index 829566e6c53..5becb79e78f 100644 --- a/interfaces/v2.Configuration.html +++ b/interfaces/v2.Configuration.html @@ -1 +1 @@ -Configuration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Hierarchy

  • Configuration

Index

Properties

Properties

Readonly authMethods

authMethods: v2.AuthMethods

Optional Readonly baseServer

baseServer?: v2.BaseServerConfiguration

Readonly debug

debug: undefined | boolean

Readonly httpApi

httpApi: v2.HttpLibrary

Readonly httpConfig

httpConfig: v2.HttpConfiguration

Readonly operationServerIndices

operationServerIndices: {}

Type declaration

  • [name: string]: number

Readonly serverIndex

serverIndex: number

unstableOperations

unstableOperations: {}

Type declaration

  • [name: string]: boolean

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +Configuration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Hierarchy

  • Configuration

Index

Properties

Properties

Readonly authMethods

authMethods: v2.AuthMethods

Optional Readonly baseServer

baseServer?: v2.BaseServerConfiguration

Readonly debug

debug: undefined | boolean

Readonly httpApi

httpApi: v2.HttpLibrary

Readonly httpConfig

httpConfig: v2.HttpConfiguration

Readonly operationServerIndices

operationServerIndices: {}

Type declaration

  • [name: string]: number

Readonly serverIndex

serverIndex: number

unstableOperations

unstableOperations: {}

Type declaration

  • [name: string]: boolean

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.DashboardListsApiCreateDashboardListItemsRequest.html b/interfaces/v2.DashboardListsApiCreateDashboardListItemsRequest.html index 4ea57fbccd5..ddeafe8cb53 100644 --- a/interfaces/v2.DashboardListsApiCreateDashboardListItemsRequest.html +++ b/interfaces/v2.DashboardListsApiCreateDashboardListItemsRequest.html @@ -1,5 +1,5 @@ -DashboardListsApiCreateDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiCreateDashboardListItemsRequest

Hierarchy

  • DashboardListsApiCreateDashboardListItemsRequest

Index

Properties

Properties

body

body: DashboardListAddItemsRequest
+DashboardListsApiCreateDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiCreateDashboardListItemsRequest

Hierarchy

  • DashboardListsApiCreateDashboardListItemsRequest

Index

Properties

Properties

body

body: DashboardListAddItemsRequest

Dashboards to add to the dashboard list.

-

dashboardListId

dashboardListId: number
+

dashboardListId

dashboardListId: number

ID of the dashboard list to add items to.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.DashboardListsApiDeleteDashboardListItemsRequest.html b/interfaces/v2.DashboardListsApiDeleteDashboardListItemsRequest.html index 23981a6a51e..3e89fe160ac 100644 --- a/interfaces/v2.DashboardListsApiDeleteDashboardListItemsRequest.html +++ b/interfaces/v2.DashboardListsApiDeleteDashboardListItemsRequest.html @@ -1,5 +1,5 @@ -DashboardListsApiDeleteDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiDeleteDashboardListItemsRequest

Hierarchy

  • DashboardListsApiDeleteDashboardListItemsRequest

Index

Properties

Properties

body

body: DashboardListDeleteItemsRequest
+DashboardListsApiDeleteDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiDeleteDashboardListItemsRequest

Hierarchy

  • DashboardListsApiDeleteDashboardListItemsRequest

Index

Properties

Properties

body

body: DashboardListDeleteItemsRequest

Dashboards to delete from the dashboard list.

-

dashboardListId

dashboardListId: number
+

dashboardListId

dashboardListId: number

ID of the dashboard list to delete items from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.DashboardListsApiGetDashboardListItemsRequest.html b/interfaces/v2.DashboardListsApiGetDashboardListItemsRequest.html index 3ff0f6d27c5..390ecfd2392 100644 --- a/interfaces/v2.DashboardListsApiGetDashboardListItemsRequest.html +++ b/interfaces/v2.DashboardListsApiGetDashboardListItemsRequest.html @@ -1,3 +1,3 @@ -DashboardListsApiGetDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiGetDashboardListItemsRequest

Hierarchy

  • DashboardListsApiGetDashboardListItemsRequest

Index

Properties

Properties

dashboardListId

dashboardListId: number
+DashboardListsApiGetDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiGetDashboardListItemsRequest

Hierarchy

  • DashboardListsApiGetDashboardListItemsRequest

Index

Properties

Properties

dashboardListId

dashboardListId: number

ID of the dashboard list to get items from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.DashboardListsApiUpdateDashboardListItemsRequest.html b/interfaces/v2.DashboardListsApiUpdateDashboardListItemsRequest.html index 2eda7e6177b..cd488a6f845 100644 --- a/interfaces/v2.DashboardListsApiUpdateDashboardListItemsRequest.html +++ b/interfaces/v2.DashboardListsApiUpdateDashboardListItemsRequest.html @@ -1,5 +1,5 @@ -DashboardListsApiUpdateDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiUpdateDashboardListItemsRequest

Hierarchy

  • DashboardListsApiUpdateDashboardListItemsRequest

Index

Properties

Properties

body

body: DashboardListUpdateItemsRequest
+DashboardListsApiUpdateDashboardListItemsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DashboardListsApiUpdateDashboardListItemsRequest

Hierarchy

  • DashboardListsApiUpdateDashboardListItemsRequest

Index

Properties

Properties

body

body: DashboardListUpdateItemsRequest

New dashboards of the dashboard list.

-

dashboardListId

dashboardListId: number
+

dashboardListId

dashboardListId: number

ID of the dashboard list to update items from.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.HttpConfiguration.html b/interfaces/v2.HttpConfiguration.html index 6fc414b88fa..75310f4c754 100644 --- a/interfaces/v2.HttpConfiguration.html +++ b/interfaces/v2.HttpConfiguration.html @@ -1,3 +1,3 @@ HttpConfiguration | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpConfiguration

Represents an HTTP transport configuration.

-

Hierarchy

  • HttpConfiguration

Index

Properties

Properties

Optional compress

compress?: boolean

Optional signal

signal?: v2.AbortSignal

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • HttpConfiguration

Index

Properties

Properties

Optional compress

compress?: boolean

Optional signal

signal?: v2.AbortSignal

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.HttpLibrary.html b/interfaces/v2.HttpLibrary.html index aa6c4b2e874..1a4fd6003bd 100644 --- a/interfaces/v2.HttpLibrary.html +++ b/interfaces/v2.HttpLibrary.html @@ -1 +1 @@ -HttpLibrary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpLibrary

Hierarchy

  • HttpLibrary

Implemented by

Index

Properties

Methods

Properties

Optional debug

debug?: boolean

Methods

send

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +HttpLibrary | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpLibrary

Hierarchy

  • HttpLibrary

Implemented by

Index

Properties

Methods

Properties

Optional debug

debug?: boolean

Methods

send

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentServicesApiCreateIncidentServiceRequest.html b/interfaces/v2.IncidentServicesApiCreateIncidentServiceRequest.html index 2b511845129..970d547063d 100644 --- a/interfaces/v2.IncidentServicesApiCreateIncidentServiceRequest.html +++ b/interfaces/v2.IncidentServicesApiCreateIncidentServiceRequest.html @@ -1,3 +1,3 @@ -IncidentServicesApiCreateIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiCreateIncidentServiceRequest

Hierarchy

  • IncidentServicesApiCreateIncidentServiceRequest

Index

Properties

Properties

body

body: IncidentServiceCreateRequest
+IncidentServicesApiCreateIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiCreateIncidentServiceRequest

Hierarchy

  • IncidentServicesApiCreateIncidentServiceRequest

Index

Properties

Properties

body

body: IncidentServiceCreateRequest

Incident Service Payload.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentServicesApiDeleteIncidentServiceRequest.html b/interfaces/v2.IncidentServicesApiDeleteIncidentServiceRequest.html index f891b0fa755..9a5de32be5f 100644 --- a/interfaces/v2.IncidentServicesApiDeleteIncidentServiceRequest.html +++ b/interfaces/v2.IncidentServicesApiDeleteIncidentServiceRequest.html @@ -1,3 +1,3 @@ -IncidentServicesApiDeleteIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiDeleteIncidentServiceRequest

Hierarchy

  • IncidentServicesApiDeleteIncidentServiceRequest

Index

Properties

Properties

serviceId

serviceId: string
+IncidentServicesApiDeleteIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiDeleteIncidentServiceRequest

Hierarchy

  • IncidentServicesApiDeleteIncidentServiceRequest

Index

Properties

Properties

serviceId

serviceId: string

The ID of the incident service.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentServicesApiGetIncidentServiceRequest.html b/interfaces/v2.IncidentServicesApiGetIncidentServiceRequest.html index 6717f25fba0..55e22e4d8e1 100644 --- a/interfaces/v2.IncidentServicesApiGetIncidentServiceRequest.html +++ b/interfaces/v2.IncidentServicesApiGetIncidentServiceRequest.html @@ -1,5 +1,5 @@ -IncidentServicesApiGetIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiGetIncidentServiceRequest

Hierarchy

  • IncidentServicesApiGetIncidentServiceRequest

Index

Properties

Properties

Optional include

include?: "users"
+IncidentServicesApiGetIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiGetIncidentServiceRequest

Hierarchy

  • IncidentServicesApiGetIncidentServiceRequest

Index

Properties

Properties

Optional include

include?: "users"

Specifies which types of related objects should be included in the response.

-

serviceId

serviceId: string
+

serviceId

serviceId: string

The ID of the incident service.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentServicesApiListIncidentServicesRequest.html b/interfaces/v2.IncidentServicesApiListIncidentServicesRequest.html index 344275cb2c4..9f0b44ada5f 100644 --- a/interfaces/v2.IncidentServicesApiListIncidentServicesRequest.html +++ b/interfaces/v2.IncidentServicesApiListIncidentServicesRequest.html @@ -1,9 +1,9 @@ -IncidentServicesApiListIncidentServicesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiListIncidentServicesRequest

Hierarchy

  • IncidentServicesApiListIncidentServicesRequest

Index

Properties

Properties

Optional filter

filter?: string
+IncidentServicesApiListIncidentServicesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiListIncidentServicesRequest

Hierarchy

  • IncidentServicesApiListIncidentServicesRequest

Index

Properties

Properties

Optional filter

filter?: string

A search query that filters services by name.

-

Optional include

include?: "users"
+

Optional include

include?: "users"

Specifies which types of related objects should be included in the response.

-

Optional pageOffset

pageOffset?: number
+

Optional pageOffset

pageOffset?: number

Specific offset to use as the beginning of the returned page.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentServicesApiUpdateIncidentServiceRequest.html b/interfaces/v2.IncidentServicesApiUpdateIncidentServiceRequest.html index b82b2889200..1a0bddeb787 100644 --- a/interfaces/v2.IncidentServicesApiUpdateIncidentServiceRequest.html +++ b/interfaces/v2.IncidentServicesApiUpdateIncidentServiceRequest.html @@ -1,5 +1,5 @@ -IncidentServicesApiUpdateIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiUpdateIncidentServiceRequest

Hierarchy

  • IncidentServicesApiUpdateIncidentServiceRequest

Index

Properties

Properties

body

body: IncidentServiceUpdateRequest
+IncidentServicesApiUpdateIncidentServiceRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentServicesApiUpdateIncidentServiceRequest

Hierarchy

  • IncidentServicesApiUpdateIncidentServiceRequest

Index

Properties

Properties

body

body: IncidentServiceUpdateRequest

Incident Service Payload.

-

serviceId

serviceId: string
+

serviceId

serviceId: string

The ID of the incident service.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentTeamsApiCreateIncidentTeamRequest.html b/interfaces/v2.IncidentTeamsApiCreateIncidentTeamRequest.html index afa842ca07b..3addc84da65 100644 --- a/interfaces/v2.IncidentTeamsApiCreateIncidentTeamRequest.html +++ b/interfaces/v2.IncidentTeamsApiCreateIncidentTeamRequest.html @@ -1,3 +1,3 @@ -IncidentTeamsApiCreateIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiCreateIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiCreateIncidentTeamRequest

Index

Properties

Properties

body

body: IncidentTeamCreateRequest
+IncidentTeamsApiCreateIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiCreateIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiCreateIncidentTeamRequest

Index

Properties

Properties

body

body: IncidentTeamCreateRequest

Incident Team Payload.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentTeamsApiDeleteIncidentTeamRequest.html b/interfaces/v2.IncidentTeamsApiDeleteIncidentTeamRequest.html index bc0a4a4a4ab..fbaaaf1bcae 100644 --- a/interfaces/v2.IncidentTeamsApiDeleteIncidentTeamRequest.html +++ b/interfaces/v2.IncidentTeamsApiDeleteIncidentTeamRequest.html @@ -1,3 +1,3 @@ -IncidentTeamsApiDeleteIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiDeleteIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiDeleteIncidentTeamRequest

Index

Properties

Properties

teamId

teamId: string
+IncidentTeamsApiDeleteIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiDeleteIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiDeleteIncidentTeamRequest

Index

Properties

Properties

teamId

teamId: string

The ID of the incident team.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentTeamsApiGetIncidentTeamRequest.html b/interfaces/v2.IncidentTeamsApiGetIncidentTeamRequest.html index 96662649f26..d1c3502533f 100644 --- a/interfaces/v2.IncidentTeamsApiGetIncidentTeamRequest.html +++ b/interfaces/v2.IncidentTeamsApiGetIncidentTeamRequest.html @@ -1,5 +1,5 @@ -IncidentTeamsApiGetIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiGetIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiGetIncidentTeamRequest

Index

Properties

Properties

Optional include

include?: "users"
+IncidentTeamsApiGetIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiGetIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiGetIncidentTeamRequest

Index

Properties

Properties

Optional include

include?: "users"

Specifies which types of related objects should be included in the response.

-

teamId

teamId: string
+

teamId

teamId: string

The ID of the incident team.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentTeamsApiListIncidentTeamsRequest.html b/interfaces/v2.IncidentTeamsApiListIncidentTeamsRequest.html index fabfd236843..02576d8072f 100644 --- a/interfaces/v2.IncidentTeamsApiListIncidentTeamsRequest.html +++ b/interfaces/v2.IncidentTeamsApiListIncidentTeamsRequest.html @@ -1,9 +1,9 @@ -IncidentTeamsApiListIncidentTeamsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiListIncidentTeamsRequest

Hierarchy

  • IncidentTeamsApiListIncidentTeamsRequest

Index

Properties

Properties

Optional filter

filter?: string
+IncidentTeamsApiListIncidentTeamsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiListIncidentTeamsRequest

Hierarchy

  • IncidentTeamsApiListIncidentTeamsRequest

Index

Properties

Properties

Optional filter

filter?: string

A search query that filters teams by name.

-

Optional include

include?: "users"
+

Optional include

include?: "users"

Specifies which types of related objects should be included in the response.

-

Optional pageOffset

pageOffset?: number
+

Optional pageOffset

pageOffset?: number

Specific offset to use as the beginning of the returned page.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentTeamsApiUpdateIncidentTeamRequest.html b/interfaces/v2.IncidentTeamsApiUpdateIncidentTeamRequest.html index 454d5d7a43b..5f6eeb604f6 100644 --- a/interfaces/v2.IncidentTeamsApiUpdateIncidentTeamRequest.html +++ b/interfaces/v2.IncidentTeamsApiUpdateIncidentTeamRequest.html @@ -1,5 +1,5 @@ -IncidentTeamsApiUpdateIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiUpdateIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiUpdateIncidentTeamRequest

Index

Properties

Properties

body

body: IncidentTeamUpdateRequest
+IncidentTeamsApiUpdateIncidentTeamRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentTeamsApiUpdateIncidentTeamRequest

Hierarchy

  • IncidentTeamsApiUpdateIncidentTeamRequest

Index

Properties

Properties

body

body: IncidentTeamUpdateRequest

Incident Team Payload.

-

teamId

teamId: string
+

teamId

teamId: string

The ID of the incident team.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentsApiCreateIncidentRequest.html b/interfaces/v2.IncidentsApiCreateIncidentRequest.html index 0992e2cc7cb..f37307f2003 100644 --- a/interfaces/v2.IncidentsApiCreateIncidentRequest.html +++ b/interfaces/v2.IncidentsApiCreateIncidentRequest.html @@ -1,3 +1,3 @@ -IncidentsApiCreateIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiCreateIncidentRequest

Hierarchy

  • IncidentsApiCreateIncidentRequest

Index

Properties

Properties

body

body: IncidentCreateRequest
+IncidentsApiCreateIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiCreateIncidentRequest

Hierarchy

  • IncidentsApiCreateIncidentRequest

Index

Properties

Properties

body

body: IncidentCreateRequest

Incident payload.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentsApiDeleteIncidentRequest.html b/interfaces/v2.IncidentsApiDeleteIncidentRequest.html index f96ac910127..2cf7ab66608 100644 --- a/interfaces/v2.IncidentsApiDeleteIncidentRequest.html +++ b/interfaces/v2.IncidentsApiDeleteIncidentRequest.html @@ -1,3 +1,3 @@ -IncidentsApiDeleteIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiDeleteIncidentRequest

Hierarchy

  • IncidentsApiDeleteIncidentRequest

Index

Properties

Properties

incidentId

incidentId: string
+IncidentsApiDeleteIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiDeleteIncidentRequest

Hierarchy

  • IncidentsApiDeleteIncidentRequest

Index

Properties

Properties

incidentId

incidentId: string

The UUID of the incident.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentsApiGetIncidentRequest.html b/interfaces/v2.IncidentsApiGetIncidentRequest.html index 2ad5d733111..067cf31b97e 100644 --- a/interfaces/v2.IncidentsApiGetIncidentRequest.html +++ b/interfaces/v2.IncidentsApiGetIncidentRequest.html @@ -1,5 +1,5 @@ -IncidentsApiGetIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiGetIncidentRequest

Hierarchy

  • IncidentsApiGetIncidentRequest

Index

Properties

Properties

incidentId

incidentId: string
+IncidentsApiGetIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiGetIncidentRequest

Hierarchy

  • IncidentsApiGetIncidentRequest

Index

Properties

Properties

incidentId

incidentId: string

The UUID of the incident.

-

Optional include

include?: "users"[]
+

Optional include

include?: "users"[]

Specifies which types of related objects should be included in the response.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentsApiListIncidentsRequest.html b/interfaces/v2.IncidentsApiListIncidentsRequest.html index 2610e160b4f..94154f5ee1a 100644 --- a/interfaces/v2.IncidentsApiListIncidentsRequest.html +++ b/interfaces/v2.IncidentsApiListIncidentsRequest.html @@ -1,7 +1,7 @@ -IncidentsApiListIncidentsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiListIncidentsRequest

Hierarchy

  • IncidentsApiListIncidentsRequest

Index

Properties

Properties

Optional include

include?: "users"[]
+IncidentsApiListIncidentsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiListIncidentsRequest

Hierarchy

  • IncidentsApiListIncidentsRequest

Index

Properties

Properties

Optional include

include?: "users"[]

Specifies which types of related objects should be included in the response.

-

Optional pageOffset

pageOffset?: number
+

Optional pageOffset

pageOffset?: number

Specific offset to use as the beginning of the returned page.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.IncidentsApiUpdateIncidentRequest.html b/interfaces/v2.IncidentsApiUpdateIncidentRequest.html index f7178e01be2..4d7e197ff25 100644 --- a/interfaces/v2.IncidentsApiUpdateIncidentRequest.html +++ b/interfaces/v2.IncidentsApiUpdateIncidentRequest.html @@ -1,7 +1,7 @@ -IncidentsApiUpdateIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiUpdateIncidentRequest

Hierarchy

  • IncidentsApiUpdateIncidentRequest

Index

Properties

Properties

body

body: IncidentUpdateRequest
+IncidentsApiUpdateIncidentRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncidentsApiUpdateIncidentRequest

Hierarchy

  • IncidentsApiUpdateIncidentRequest

Index

Properties

Properties

body

body: IncidentUpdateRequest

Incident Payload.

-

incidentId

incidentId: string
+

incidentId

incidentId: string

The UUID of the incident.

-

Optional include

include?: "users"[]
+

Optional include

include?: "users"[]

Specifies which types of related objects should be included in the response.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiCreateAPIKeyRequest.html b/interfaces/v2.KeyManagementApiCreateAPIKeyRequest.html index 9a172446691..4fabf83585a 100644 --- a/interfaces/v2.KeyManagementApiCreateAPIKeyRequest.html +++ b/interfaces/v2.KeyManagementApiCreateAPIKeyRequest.html @@ -1 +1 @@ -KeyManagementApiCreateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateAPIKeyRequest

Hierarchy

  • KeyManagementApiCreateAPIKeyRequest

Index

Properties

Properties

body

body: APIKeyCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +KeyManagementApiCreateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateAPIKeyRequest

Hierarchy

  • KeyManagementApiCreateAPIKeyRequest

Index

Properties

Properties

body

body: APIKeyCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiCreateCurrentUserApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiCreateCurrentUserApplicationKeyRequest.html index 98051c80c14..bd581bbaebe 100644 --- a/interfaces/v2.KeyManagementApiCreateCurrentUserApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiCreateCurrentUserApplicationKeyRequest.html @@ -1 +1 @@ -KeyManagementApiCreateCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiCreateCurrentUserApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKeyCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +KeyManagementApiCreateCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiCreateCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiCreateCurrentUserApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKeyCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiDeleteAPIKeyRequest.html b/interfaces/v2.KeyManagementApiDeleteAPIKeyRequest.html index a2d65bb891c..0ae25f92302 100644 --- a/interfaces/v2.KeyManagementApiDeleteAPIKeyRequest.html +++ b/interfaces/v2.KeyManagementApiDeleteAPIKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiDeleteAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteAPIKeyRequest

Hierarchy

  • KeyManagementApiDeleteAPIKeyRequest

Index

Properties

Properties

apiKeyId

apiKeyId: string
+KeyManagementApiDeleteAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteAPIKeyRequest

Hierarchy

  • KeyManagementApiDeleteAPIKeyRequest

Index

Properties

Properties

apiKeyId

apiKeyId: string

The ID of the API key.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiDeleteApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiDeleteApplicationKeyRequest.html index 720227b4c02..d024546e1af 100644 --- a/interfaces/v2.KeyManagementApiDeleteApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiDeleteApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiDeleteApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteApplicationKeyRequest

Hierarchy

  • KeyManagementApiDeleteApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+KeyManagementApiDeleteApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteApplicationKeyRequest

Hierarchy

  • KeyManagementApiDeleteApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiDeleteCurrentUserApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiDeleteCurrentUserApplicationKeyRequest.html index 4ca2db1fb5b..5bd9efb1741 100644 --- a/interfaces/v2.KeyManagementApiDeleteCurrentUserApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiDeleteCurrentUserApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiDeleteCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiDeleteCurrentUserApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+KeyManagementApiDeleteCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiDeleteCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiDeleteCurrentUserApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiGetAPIKeyRequest.html b/interfaces/v2.KeyManagementApiGetAPIKeyRequest.html index 7398a1c1de4..b85708e44b1 100644 --- a/interfaces/v2.KeyManagementApiGetAPIKeyRequest.html +++ b/interfaces/v2.KeyManagementApiGetAPIKeyRequest.html @@ -1,5 +1,5 @@ -KeyManagementApiGetAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetAPIKeyRequest

Hierarchy

  • KeyManagementApiGetAPIKeyRequest

Index

Properties

Properties

apiKeyId

apiKeyId: string
+KeyManagementApiGetAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetAPIKeyRequest

Hierarchy

  • KeyManagementApiGetAPIKeyRequest

Index

Properties

Properties

apiKeyId

apiKeyId: string

The ID of the API key.

-

Optional include

include?: string
+

Optional include

include?: string

Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiGetApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiGetApplicationKeyRequest.html index 59a637ae51e..f301a1cd3c9 100644 --- a/interfaces/v2.KeyManagementApiGetApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiGetApplicationKeyRequest.html @@ -1,5 +1,5 @@ -KeyManagementApiGetApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetApplicationKeyRequest

Hierarchy

  • KeyManagementApiGetApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+KeyManagementApiGetApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetApplicationKeyRequest

Hierarchy

  • KeyManagementApiGetApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

-

Optional include

include?: string
+

Optional include

include?: string

Resource path for related resources to include in the response. Only `owned_by` is supported.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiGetCurrentUserApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiGetCurrentUserApplicationKeyRequest.html index d6f64b0d383..22a64a735f7 100644 --- a/interfaces/v2.KeyManagementApiGetCurrentUserApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiGetCurrentUserApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiGetCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiGetCurrentUserApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+KeyManagementApiGetCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiGetCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiGetCurrentUserApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiListAPIKeysRequest.html b/interfaces/v2.KeyManagementApiListAPIKeysRequest.html index 5782031287f..d7d39324ce4 100644 --- a/interfaces/v2.KeyManagementApiListAPIKeysRequest.html +++ b/interfaces/v2.KeyManagementApiListAPIKeysRequest.html @@ -1,19 +1,19 @@ -KeyManagementApiListAPIKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiListAPIKeysRequest

Hierarchy

  • KeyManagementApiListAPIKeysRequest

Index

Properties

Properties

Optional filter

filter?: string
+KeyManagementApiListAPIKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiListAPIKeysRequest

Hierarchy

  • KeyManagementApiListAPIKeysRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter API keys by the specified string.

-

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string
+

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string

Only include API keys created on or before the specified date.

-

Optional filterCreatedAtStart

filterCreatedAtStart?: string
+

Optional filterCreatedAtStart

filterCreatedAtStart?: string

Only include API keys created on or after the specified date.

-

Optional filterModifiedAtEnd

filterModifiedAtEnd?: string
+

Optional filterModifiedAtEnd

filterModifiedAtEnd?: string

Only include API keys modified on or before the specified date.

-

Optional filterModifiedAtStart

filterModifiedAtStart?: string
+

Optional filterModifiedAtStart

filterModifiedAtStart?: string

Only include API keys modified on or after the specified date.

-

Optional include

include?: string
+

Optional include

include?: string

Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

Optional sort

sort?: APIKeysSort
+

Optional sort

sort?: APIKeysSort

API key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiListApplicationKeysRequest.html b/interfaces/v2.KeyManagementApiListApplicationKeysRequest.html index 33f928277d0..20bfe6a8611 100644 --- a/interfaces/v2.KeyManagementApiListApplicationKeysRequest.html +++ b/interfaces/v2.KeyManagementApiListApplicationKeysRequest.html @@ -1,13 +1,13 @@ -KeyManagementApiListApplicationKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiListApplicationKeysRequest

Hierarchy

  • KeyManagementApiListApplicationKeysRequest

Index

Properties

Properties

Optional filter

filter?: string
+KeyManagementApiListApplicationKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiListApplicationKeysRequest

Hierarchy

  • KeyManagementApiListApplicationKeysRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter application keys by the specified string.

-

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string
+

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string

Only include application keys created on or before the specified date.

-

Optional filterCreatedAtStart

filterCreatedAtStart?: string
+

Optional filterCreatedAtStart

filterCreatedAtStart?: string

Only include application keys created on or after the specified date.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

Optional sort

sort?: ApplicationKeysSort
+

Optional sort

sort?: ApplicationKeysSort

Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiListCurrentUserApplicationKeysRequest.html b/interfaces/v2.KeyManagementApiListCurrentUserApplicationKeysRequest.html index 4ee1ab7b020..ebac50e1b9e 100644 --- a/interfaces/v2.KeyManagementApiListCurrentUserApplicationKeysRequest.html +++ b/interfaces/v2.KeyManagementApiListCurrentUserApplicationKeysRequest.html @@ -1,13 +1,13 @@ -KeyManagementApiListCurrentUserApplicationKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiListCurrentUserApplicationKeysRequest

Hierarchy

  • KeyManagementApiListCurrentUserApplicationKeysRequest

Index

Properties

Properties

Optional filter

filter?: string
+KeyManagementApiListCurrentUserApplicationKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiListCurrentUserApplicationKeysRequest

Hierarchy

  • KeyManagementApiListCurrentUserApplicationKeysRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter application keys by the specified string.

-

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string
+

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string

Only include application keys created on or before the specified date.

-

Optional filterCreatedAtStart

filterCreatedAtStart?: string
+

Optional filterCreatedAtStart

filterCreatedAtStart?: string

Only include application keys created on or after the specified date.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

Optional sort

sort?: ApplicationKeysSort
+

Optional sort

sort?: ApplicationKeysSort

Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiUpdateAPIKeyRequest.html b/interfaces/v2.KeyManagementApiUpdateAPIKeyRequest.html index 8dfdf779b35..2bdf9dcd2b8 100644 --- a/interfaces/v2.KeyManagementApiUpdateAPIKeyRequest.html +++ b/interfaces/v2.KeyManagementApiUpdateAPIKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiUpdateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateAPIKeyRequest

Hierarchy

  • KeyManagementApiUpdateAPIKeyRequest

Index

Properties

Properties

apiKeyId

apiKeyId: string
+KeyManagementApiUpdateAPIKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateAPIKeyRequest

Hierarchy

  • KeyManagementApiUpdateAPIKeyRequest

Index

Properties

Properties

apiKeyId

apiKeyId: string

The ID of the API key.

-

body

body: APIKeyUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

body

body: APIKeyUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiUpdateApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiUpdateApplicationKeyRequest.html index ede3a378206..a6e63ae83ab 100644 --- a/interfaces/v2.KeyManagementApiUpdateApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiUpdateApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiUpdateApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateApplicationKeyRequest

Hierarchy

  • KeyManagementApiUpdateApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+KeyManagementApiUpdateApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateApplicationKeyRequest

Hierarchy

  • KeyManagementApiUpdateApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

-

body

body: ApplicationKeyUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

body

body: ApplicationKeyUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.KeyManagementApiUpdateCurrentUserApplicationKeyRequest.html b/interfaces/v2.KeyManagementApiUpdateCurrentUserApplicationKeyRequest.html index 9f0e7c65b4b..7eb863dc41d 100644 --- a/interfaces/v2.KeyManagementApiUpdateCurrentUserApplicationKeyRequest.html +++ b/interfaces/v2.KeyManagementApiUpdateCurrentUserApplicationKeyRequest.html @@ -1,3 +1,3 @@ -KeyManagementApiUpdateCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiUpdateCurrentUserApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+KeyManagementApiUpdateCurrentUserApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyManagementApiUpdateCurrentUserApplicationKeyRequest

Hierarchy

  • KeyManagementApiUpdateCurrentUserApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

-

body

body: ApplicationKeyUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

body

body: ApplicationKeyUpdateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsApiAggregateLogsRequest.html b/interfaces/v2.LogsApiAggregateLogsRequest.html index 7ccdf9a9a0b..52ae2710024 100644 --- a/interfaces/v2.LogsApiAggregateLogsRequest.html +++ b/interfaces/v2.LogsApiAggregateLogsRequest.html @@ -1 +1 @@ -LogsApiAggregateLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiAggregateLogsRequest

Hierarchy

  • LogsApiAggregateLogsRequest

Index

Properties

Properties

body

body: LogsAggregateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +LogsApiAggregateLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiAggregateLogsRequest

Hierarchy

  • LogsApiAggregateLogsRequest

Index

Properties

Properties

body

body: LogsAggregateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsApiListLogsGetRequest.html b/interfaces/v2.LogsApiListLogsGetRequest.html index 03cbf448b7c..ad15c96e193 100644 --- a/interfaces/v2.LogsApiListLogsGetRequest.html +++ b/interfaces/v2.LogsApiListLogsGetRequest.html @@ -1,15 +1,15 @@ -LogsApiListLogsGetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiListLogsGetRequest

Hierarchy

  • LogsApiListLogsGetRequest

Index

Properties

Properties

Optional filterFrom

filterFrom?: Date
+LogsApiListLogsGetRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiListLogsGetRequest

Hierarchy

  • LogsApiListLogsGetRequest

Index

Properties

Properties

Optional filterFrom

filterFrom?: Date

Minimum timestamp for requested logs.

-

Optional filterIndex

filterIndex?: string
+

Optional filterIndex

filterIndex?: string

For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes

-

Optional filterQuery

filterQuery?: string
+

Optional filterQuery

filterQuery?: string

Search query following logs syntax.

-

Optional filterTo

filterTo?: Date
+

Optional filterTo

filterTo?: Date

Maximum timestamp for requested logs.

-

Optional pageCursor

pageCursor?: string
+

Optional pageCursor

pageCursor?: string

List following results with a cursor provided in the previous query.

-

Optional pageLimit

pageLimit?: number
+

Optional pageLimit

pageLimit?: number

Maximum number of logs in the response.

-

Optional sort

sort?: v2.LogsSort
+

Optional sort

sort?: v2.LogsSort

Order of logs in results.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsApiListLogsRequest.html b/interfaces/v2.LogsApiListLogsRequest.html index bfb4e8c6859..0d4dd0be532 100644 --- a/interfaces/v2.LogsApiListLogsRequest.html +++ b/interfaces/v2.LogsApiListLogsRequest.html @@ -1 +1 @@ -LogsApiListLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiListLogsRequest

Hierarchy

  • LogsApiListLogsRequest

Index

Properties

Properties

Optional body

body?: v2.LogsListRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +LogsApiListLogsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiListLogsRequest

Hierarchy

  • LogsApiListLogsRequest

Index

Properties

Properties

Optional body

body?: v2.LogsListRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsApiSubmitLogRequest.html b/interfaces/v2.LogsApiSubmitLogRequest.html index ecde5c344e1..e1bdeeef6e4 100644 --- a/interfaces/v2.LogsApiSubmitLogRequest.html +++ b/interfaces/v2.LogsApiSubmitLogRequest.html @@ -1,7 +1,7 @@ -LogsApiSubmitLogRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiSubmitLogRequest

Hierarchy

  • LogsApiSubmitLogRequest

Index

Properties

Properties

body

body: v2.HTTPLogItem[]
+LogsApiSubmitLogRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsApiSubmitLogRequest

Hierarchy

  • LogsApiSubmitLogRequest

Index

Properties

Properties

body

body: v2.HTTPLogItem[]

Log to send (JSON format).

-

Optional contentEncoding

contentEncoding?: v2.ContentEncoding
+

Optional contentEncoding

contentEncoding?: v2.ContentEncoding

HTTP header used to compress the media-type.

-

Optional ddtags

ddtags?: string
+

Optional ddtags

ddtags?: string

Log tags can be passed as query parameters with `text/plain` content type.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiAddReadRoleToArchiveRequest.html b/interfaces/v2.LogsArchivesApiAddReadRoleToArchiveRequest.html index 2d9b0d5b2f6..1e76bfe6217 100644 --- a/interfaces/v2.LogsArchivesApiAddReadRoleToArchiveRequest.html +++ b/interfaces/v2.LogsArchivesApiAddReadRoleToArchiveRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiAddReadRoleToArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiAddReadRoleToArchiveRequest

Hierarchy

  • LogsArchivesApiAddReadRoleToArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string
+LogsArchivesApiAddReadRoleToArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiAddReadRoleToArchiveRequest

Hierarchy

  • LogsArchivesApiAddReadRoleToArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string

The ID of the archive.

-

body

body: RelationshipToRole

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

body

body: RelationshipToRole

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiCreateLogsArchiveRequest.html b/interfaces/v2.LogsArchivesApiCreateLogsArchiveRequest.html index 834daeded13..81c8c1b443c 100644 --- a/interfaces/v2.LogsArchivesApiCreateLogsArchiveRequest.html +++ b/interfaces/v2.LogsArchivesApiCreateLogsArchiveRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiCreateLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiCreateLogsArchiveRequest

Hierarchy

  • LogsArchivesApiCreateLogsArchiveRequest

Index

Properties

Properties

body

body: LogsArchiveCreateRequest
+LogsArchivesApiCreateLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiCreateLogsArchiveRequest

Hierarchy

  • LogsArchivesApiCreateLogsArchiveRequest

Index

Properties

Properties

body

body: LogsArchiveCreateRequest

The definition of the new archive.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiDeleteLogsArchiveRequest.html b/interfaces/v2.LogsArchivesApiDeleteLogsArchiveRequest.html index f33bfe3a397..7072fc0116c 100644 --- a/interfaces/v2.LogsArchivesApiDeleteLogsArchiveRequest.html +++ b/interfaces/v2.LogsArchivesApiDeleteLogsArchiveRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiDeleteLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiDeleteLogsArchiveRequest

Hierarchy

  • LogsArchivesApiDeleteLogsArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string
+LogsArchivesApiDeleteLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiDeleteLogsArchiveRequest

Hierarchy

  • LogsArchivesApiDeleteLogsArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string

The ID of the archive.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiGetLogsArchiveRequest.html b/interfaces/v2.LogsArchivesApiGetLogsArchiveRequest.html index e513d4effec..be47d0cfaaa 100644 --- a/interfaces/v2.LogsArchivesApiGetLogsArchiveRequest.html +++ b/interfaces/v2.LogsArchivesApiGetLogsArchiveRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiGetLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiGetLogsArchiveRequest

Hierarchy

  • LogsArchivesApiGetLogsArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string
+LogsArchivesApiGetLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiGetLogsArchiveRequest

Hierarchy

  • LogsArchivesApiGetLogsArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string

The ID of the archive.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiListArchiveReadRolesRequest.html b/interfaces/v2.LogsArchivesApiListArchiveReadRolesRequest.html index fcf787cd3f6..b2eb913e7a8 100644 --- a/interfaces/v2.LogsArchivesApiListArchiveReadRolesRequest.html +++ b/interfaces/v2.LogsArchivesApiListArchiveReadRolesRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiListArchiveReadRolesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiListArchiveReadRolesRequest

Hierarchy

  • LogsArchivesApiListArchiveReadRolesRequest

Index

Properties

Properties

archiveId

archiveId: string
+LogsArchivesApiListArchiveReadRolesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiListArchiveReadRolesRequest

Hierarchy

  • LogsArchivesApiListArchiveReadRolesRequest

Index

Properties

Properties

archiveId

archiveId: string

The ID of the archive.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiRemoveRoleFromArchiveRequest.html b/interfaces/v2.LogsArchivesApiRemoveRoleFromArchiveRequest.html index e47a8765d09..6484cd76f55 100644 --- a/interfaces/v2.LogsArchivesApiRemoveRoleFromArchiveRequest.html +++ b/interfaces/v2.LogsArchivesApiRemoveRoleFromArchiveRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiRemoveRoleFromArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiRemoveRoleFromArchiveRequest

Hierarchy

  • LogsArchivesApiRemoveRoleFromArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string
+LogsArchivesApiRemoveRoleFromArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiRemoveRoleFromArchiveRequest

Hierarchy

  • LogsArchivesApiRemoveRoleFromArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string

The ID of the archive.

-

body

body: RelationshipToRole

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

body

body: RelationshipToRole

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiUpdateLogsArchiveOrderRequest.html b/interfaces/v2.LogsArchivesApiUpdateLogsArchiveOrderRequest.html index 8379b21bcba..e04f18e1b38 100644 --- a/interfaces/v2.LogsArchivesApiUpdateLogsArchiveOrderRequest.html +++ b/interfaces/v2.LogsArchivesApiUpdateLogsArchiveOrderRequest.html @@ -1,3 +1,3 @@ -LogsArchivesApiUpdateLogsArchiveOrderRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiUpdateLogsArchiveOrderRequest

Hierarchy

  • LogsArchivesApiUpdateLogsArchiveOrderRequest

Index

Properties

Properties

body

body: LogsArchiveOrder
+LogsArchivesApiUpdateLogsArchiveOrderRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiUpdateLogsArchiveOrderRequest

Hierarchy

  • LogsArchivesApiUpdateLogsArchiveOrderRequest

Index

Properties

Properties

body

body: LogsArchiveOrder

An object containing the new ordered list of archive IDs.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsArchivesApiUpdateLogsArchiveRequest.html b/interfaces/v2.LogsArchivesApiUpdateLogsArchiveRequest.html index 7aa2f4e3a1b..77f51e8867c 100644 --- a/interfaces/v2.LogsArchivesApiUpdateLogsArchiveRequest.html +++ b/interfaces/v2.LogsArchivesApiUpdateLogsArchiveRequest.html @@ -1,5 +1,5 @@ -LogsArchivesApiUpdateLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiUpdateLogsArchiveRequest

Hierarchy

  • LogsArchivesApiUpdateLogsArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string
+LogsArchivesApiUpdateLogsArchiveRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsArchivesApiUpdateLogsArchiveRequest

Hierarchy

  • LogsArchivesApiUpdateLogsArchiveRequest

Index

Properties

Properties

archiveId

archiveId: string

The ID of the archive.

-

body

body: LogsArchiveCreateRequest
+

body

body: LogsArchiveCreateRequest

New definition of the archive.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsMetricsApiCreateLogsMetricRequest.html b/interfaces/v2.LogsMetricsApiCreateLogsMetricRequest.html index 2c7d8c6622b..3b5f4b91b20 100644 --- a/interfaces/v2.LogsMetricsApiCreateLogsMetricRequest.html +++ b/interfaces/v2.LogsMetricsApiCreateLogsMetricRequest.html @@ -1,3 +1,3 @@ -LogsMetricsApiCreateLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiCreateLogsMetricRequest

Hierarchy

  • LogsMetricsApiCreateLogsMetricRequest

Index

Properties

Properties

body

body: LogsMetricCreateRequest
+LogsMetricsApiCreateLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiCreateLogsMetricRequest

Hierarchy

  • LogsMetricsApiCreateLogsMetricRequest

Index

Properties

Properties

body

body: LogsMetricCreateRequest

The definition of the new log-based metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsMetricsApiDeleteLogsMetricRequest.html b/interfaces/v2.LogsMetricsApiDeleteLogsMetricRequest.html index 2a8cc16e611..fb6e029a260 100644 --- a/interfaces/v2.LogsMetricsApiDeleteLogsMetricRequest.html +++ b/interfaces/v2.LogsMetricsApiDeleteLogsMetricRequest.html @@ -1,3 +1,3 @@ -LogsMetricsApiDeleteLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiDeleteLogsMetricRequest

Hierarchy

  • LogsMetricsApiDeleteLogsMetricRequest

Index

Properties

Properties

metricId

metricId: string
+LogsMetricsApiDeleteLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiDeleteLogsMetricRequest

Hierarchy

  • LogsMetricsApiDeleteLogsMetricRequest

Index

Properties

Properties

metricId

metricId: string

The name of the log-based metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsMetricsApiGetLogsMetricRequest.html b/interfaces/v2.LogsMetricsApiGetLogsMetricRequest.html index 92cd88651e0..f0d30700958 100644 --- a/interfaces/v2.LogsMetricsApiGetLogsMetricRequest.html +++ b/interfaces/v2.LogsMetricsApiGetLogsMetricRequest.html @@ -1,3 +1,3 @@ -LogsMetricsApiGetLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiGetLogsMetricRequest

Hierarchy

  • LogsMetricsApiGetLogsMetricRequest

Index

Properties

Properties

metricId

metricId: string
+LogsMetricsApiGetLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiGetLogsMetricRequest

Hierarchy

  • LogsMetricsApiGetLogsMetricRequest

Index

Properties

Properties

metricId

metricId: string

The name of the log-based metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.LogsMetricsApiUpdateLogsMetricRequest.html b/interfaces/v2.LogsMetricsApiUpdateLogsMetricRequest.html index 7a10412d610..fb5aa9e3a47 100644 --- a/interfaces/v2.LogsMetricsApiUpdateLogsMetricRequest.html +++ b/interfaces/v2.LogsMetricsApiUpdateLogsMetricRequest.html @@ -1,5 +1,5 @@ -LogsMetricsApiUpdateLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiUpdateLogsMetricRequest

Hierarchy

  • LogsMetricsApiUpdateLogsMetricRequest

Index

Properties

Properties

body

body: LogsMetricUpdateRequest
+LogsMetricsApiUpdateLogsMetricRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LogsMetricsApiUpdateLogsMetricRequest

Hierarchy

  • LogsMetricsApiUpdateLogsMetricRequest

Index

Properties

Properties

body

body: LogsMetricUpdateRequest

New definition of the log-based metric.

-

metricId

metricId: string
+

metricId

metricId: string

The name of the log-based metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiCreateBulkTagsMetricsConfigurationRequest.html b/interfaces/v2.MetricsApiCreateBulkTagsMetricsConfigurationRequest.html index 262ec553a9d..0120a307e98 100644 --- a/interfaces/v2.MetricsApiCreateBulkTagsMetricsConfigurationRequest.html +++ b/interfaces/v2.MetricsApiCreateBulkTagsMetricsConfigurationRequest.html @@ -1 +1 @@ -MetricsApiCreateBulkTagsMetricsConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiCreateBulkTagsMetricsConfigurationRequest

Hierarchy

  • MetricsApiCreateBulkTagsMetricsConfigurationRequest

Index

Properties

Properties

body

body: MetricBulkTagConfigCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +MetricsApiCreateBulkTagsMetricsConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiCreateBulkTagsMetricsConfigurationRequest

Hierarchy

  • MetricsApiCreateBulkTagsMetricsConfigurationRequest

Index

Properties

Properties

body

body: MetricBulkTagConfigCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiCreateTagConfigurationRequest.html b/interfaces/v2.MetricsApiCreateTagConfigurationRequest.html index d1e7adc7a37..56c99e6a519 100644 --- a/interfaces/v2.MetricsApiCreateTagConfigurationRequest.html +++ b/interfaces/v2.MetricsApiCreateTagConfigurationRequest.html @@ -1,3 +1,3 @@ -MetricsApiCreateTagConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiCreateTagConfigurationRequest

Hierarchy

  • MetricsApiCreateTagConfigurationRequest

Index

Properties

Properties

body

body: MetricTagConfigurationCreateRequest

metricName

metricName: string
+MetricsApiCreateTagConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiCreateTagConfigurationRequest

Hierarchy

  • MetricsApiCreateTagConfigurationRequest

Index

Properties

Properties

body

body: MetricTagConfigurationCreateRequest

metricName

metricName: string

The name of the metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiDeleteBulkTagsMetricsConfigurationRequest.html b/interfaces/v2.MetricsApiDeleteBulkTagsMetricsConfigurationRequest.html index 3714651d6aa..e3e5efb406a 100644 --- a/interfaces/v2.MetricsApiDeleteBulkTagsMetricsConfigurationRequest.html +++ b/interfaces/v2.MetricsApiDeleteBulkTagsMetricsConfigurationRequest.html @@ -1 +1 @@ -MetricsApiDeleteBulkTagsMetricsConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiDeleteBulkTagsMetricsConfigurationRequest

Hierarchy

  • MetricsApiDeleteBulkTagsMetricsConfigurationRequest

Index

Properties

Properties

body

body: MetricBulkTagConfigDeleteRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +MetricsApiDeleteBulkTagsMetricsConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiDeleteBulkTagsMetricsConfigurationRequest

Hierarchy

  • MetricsApiDeleteBulkTagsMetricsConfigurationRequest

Index

Properties

Properties

body

body: MetricBulkTagConfigDeleteRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiDeleteTagConfigurationRequest.html b/interfaces/v2.MetricsApiDeleteTagConfigurationRequest.html index c5fb9d69290..67f892109c1 100644 --- a/interfaces/v2.MetricsApiDeleteTagConfigurationRequest.html +++ b/interfaces/v2.MetricsApiDeleteTagConfigurationRequest.html @@ -1,3 +1,3 @@ -MetricsApiDeleteTagConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiDeleteTagConfigurationRequest

Hierarchy

  • MetricsApiDeleteTagConfigurationRequest

Index

Properties

Properties

metricName

metricName: string
+MetricsApiDeleteTagConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiDeleteTagConfigurationRequest

Hierarchy

  • MetricsApiDeleteTagConfigurationRequest

Index

Properties

Properties

metricName

metricName: string

The name of the metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiListTagConfigurationByNameRequest.html b/interfaces/v2.MetricsApiListTagConfigurationByNameRequest.html index 83618fc70af..085a6785d26 100644 --- a/interfaces/v2.MetricsApiListTagConfigurationByNameRequest.html +++ b/interfaces/v2.MetricsApiListTagConfigurationByNameRequest.html @@ -1,3 +1,3 @@ -MetricsApiListTagConfigurationByNameRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListTagConfigurationByNameRequest

Hierarchy

  • MetricsApiListTagConfigurationByNameRequest

Index

Properties

Properties

metricName

metricName: string
+MetricsApiListTagConfigurationByNameRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListTagConfigurationByNameRequest

Hierarchy

  • MetricsApiListTagConfigurationByNameRequest

Index

Properties

Properties

metricName

metricName: string

The name of the metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiListTagConfigurationsRequest.html b/interfaces/v2.MetricsApiListTagConfigurationsRequest.html index b880f4d0551..97d45d669e9 100644 --- a/interfaces/v2.MetricsApiListTagConfigurationsRequest.html +++ b/interfaces/v2.MetricsApiListTagConfigurationsRequest.html @@ -1,13 +1,13 @@ -MetricsApiListTagConfigurationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListTagConfigurationsRequest

Hierarchy

  • MetricsApiListTagConfigurationsRequest

Index

Properties

Properties

Optional filterConfigured

filterConfigured?: boolean
+MetricsApiListTagConfigurationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListTagConfigurationsRequest

Hierarchy

  • MetricsApiListTagConfigurationsRequest

Index

Properties

Properties

Optional filterConfigured

filterConfigured?: boolean

Filter metrics that have configured tags.

-

Optional filterIncludePercentiles

filterIncludePercentiles?: boolean
+

Optional filterIncludePercentiles

filterIncludePercentiles?: boolean

Filter distributions with additional percentile aggregations enabled or disabled.

-

Optional filterMetricType

filterMetricType?: MetricTagConfigurationMetricTypes
+

Optional filterMetricType

filterMetricType?: MetricTagConfigurationMetricTypes

Filter tag configurations by metric type.

-

Optional filterTags

filterTags?: string
+

Optional filterTags

filterTags?: string

Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters.

-

Optional filterTagsConfigured

filterTagsConfigured?: string
+

Optional filterTagsConfigured

filterTagsConfigured?: string

Filter tag configurations by configured tags.

-

Optional windowSeconds

windowSeconds?: number
+

Optional windowSeconds

windowSeconds?: number

The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days).

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiListTagsByMetricNameRequest.html b/interfaces/v2.MetricsApiListTagsByMetricNameRequest.html index 7bde5021491..85249576eb7 100644 --- a/interfaces/v2.MetricsApiListTagsByMetricNameRequest.html +++ b/interfaces/v2.MetricsApiListTagsByMetricNameRequest.html @@ -1,3 +1,3 @@ -MetricsApiListTagsByMetricNameRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListTagsByMetricNameRequest

Hierarchy

  • MetricsApiListTagsByMetricNameRequest

Index

Properties

Properties

metricName

metricName: string
+MetricsApiListTagsByMetricNameRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListTagsByMetricNameRequest

Hierarchy

  • MetricsApiListTagsByMetricNameRequest

Index

Properties

Properties

metricName

metricName: string

The name of the metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiListVolumesByMetricNameRequest.html b/interfaces/v2.MetricsApiListVolumesByMetricNameRequest.html index 20d50887ba9..9cce41b50b2 100644 --- a/interfaces/v2.MetricsApiListVolumesByMetricNameRequest.html +++ b/interfaces/v2.MetricsApiListVolumesByMetricNameRequest.html @@ -1,3 +1,3 @@ -MetricsApiListVolumesByMetricNameRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListVolumesByMetricNameRequest

Hierarchy

  • MetricsApiListVolumesByMetricNameRequest

Index

Properties

Properties

metricName

metricName: string
+MetricsApiListVolumesByMetricNameRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiListVolumesByMetricNameRequest

Hierarchy

  • MetricsApiListVolumesByMetricNameRequest

Index

Properties

Properties

metricName

metricName: string

The name of the metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.MetricsApiUpdateTagConfigurationRequest.html b/interfaces/v2.MetricsApiUpdateTagConfigurationRequest.html index 08ba9cbf39f..e700cc24632 100644 --- a/interfaces/v2.MetricsApiUpdateTagConfigurationRequest.html +++ b/interfaces/v2.MetricsApiUpdateTagConfigurationRequest.html @@ -1,3 +1,3 @@ -MetricsApiUpdateTagConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiUpdateTagConfigurationRequest

Hierarchy

  • MetricsApiUpdateTagConfigurationRequest

Index

Properties

Properties

body

body: MetricTagConfigurationUpdateRequest

metricName

metricName: string
+MetricsApiUpdateTagConfigurationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsApiUpdateTagConfigurationRequest

Hierarchy

  • MetricsApiUpdateTagConfigurationRequest

Index

Properties

Properties

body

body: MetricTagConfigurationUpdateRequest

metricName

metricName: string

The name of the metric.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ProcessesApiListProcessesRequest.html b/interfaces/v2.ProcessesApiListProcessesRequest.html index 0338b8a80ac..7b13815bfd9 100644 --- a/interfaces/v2.ProcessesApiListProcessesRequest.html +++ b/interfaces/v2.ProcessesApiListProcessesRequest.html @@ -1,13 +1,13 @@ -ProcessesApiListProcessesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProcessesApiListProcessesRequest

Hierarchy

  • ProcessesApiListProcessesRequest

Index

Properties

Properties

Optional from

from?: number
+ProcessesApiListProcessesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProcessesApiListProcessesRequest

Hierarchy

  • ProcessesApiListProcessesRequest

Index

Properties

Properties

Optional from

from?: number

Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.

-

Optional pageCursor

pageCursor?: string
+

Optional pageCursor

pageCursor?: string

String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`.

-

Optional pageLimit

pageLimit?: number
+

Optional pageLimit

pageLimit?: number

Maximum number of results returned.

-

Optional search

search?: string
+

Optional search

search?: string

String to search processes by.

-

Optional tags

tags?: string
+

Optional tags

tags?: string

Comma-separated list of tags to filter processes by.

-

Optional to

to?: number
+

Optional to

to?: number

Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ResponseBody.html b/interfaces/v2.ResponseBody.html index 60e19a35f6a..587a1eef5c4 100644 --- a/interfaces/v2.ResponseBody.html +++ b/interfaces/v2.ResponseBody.html @@ -1 +1 @@ -ResponseBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResponseBody

Hierarchy

  • ResponseBody

Implemented by

Index

Methods

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +ResponseBody | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ResponseBody

Hierarchy

  • ResponseBody

Implemented by

Index

Methods

Methods

binary

  • binary(): Promise<Buffer>

text

  • text(): Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiAddPermissionToRoleRequest.html b/interfaces/v2.RolesApiAddPermissionToRoleRequest.html index 1d405f553f0..71c317e940b 100644 --- a/interfaces/v2.RolesApiAddPermissionToRoleRequest.html +++ b/interfaces/v2.RolesApiAddPermissionToRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiAddPermissionToRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiAddPermissionToRoleRequest

Hierarchy

  • RolesApiAddPermissionToRoleRequest

Index

Properties

Properties

body

body: RelationshipToPermission

roleId

roleId: string
+RolesApiAddPermissionToRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiAddPermissionToRoleRequest

Hierarchy

  • RolesApiAddPermissionToRoleRequest

Index

Properties

Properties

body

body: RelationshipToPermission

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiAddUserToRoleRequest.html b/interfaces/v2.RolesApiAddUserToRoleRequest.html index e7619999d07..74d608be3b7 100644 --- a/interfaces/v2.RolesApiAddUserToRoleRequest.html +++ b/interfaces/v2.RolesApiAddUserToRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiAddUserToRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiAddUserToRoleRequest

Hierarchy

  • RolesApiAddUserToRoleRequest

Index

Properties

Properties

body

body: RelationshipToUser

roleId

roleId: string
+RolesApiAddUserToRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiAddUserToRoleRequest

Hierarchy

  • RolesApiAddUserToRoleRequest

Index

Properties

Properties

body

body: RelationshipToUser

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiCloneRoleRequest.html b/interfaces/v2.RolesApiCloneRoleRequest.html index a68ab490182..4694f647465 100644 --- a/interfaces/v2.RolesApiCloneRoleRequest.html +++ b/interfaces/v2.RolesApiCloneRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiCloneRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiCloneRoleRequest

Hierarchy

  • RolesApiCloneRoleRequest

Index

Properties

Properties

body

body: RoleCloneRequest

roleId

roleId: string
+RolesApiCloneRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiCloneRoleRequest

Hierarchy

  • RolesApiCloneRoleRequest

Index

Properties

Properties

body

body: RoleCloneRequest

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiCreateRoleRequest.html b/interfaces/v2.RolesApiCreateRoleRequest.html index 1d77801caf8..935401edba7 100644 --- a/interfaces/v2.RolesApiCreateRoleRequest.html +++ b/interfaces/v2.RolesApiCreateRoleRequest.html @@ -1 +1 @@ -RolesApiCreateRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiCreateRoleRequest

Hierarchy

  • RolesApiCreateRoleRequest

Index

Properties

Properties

body

body: RoleCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +RolesApiCreateRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiCreateRoleRequest

Hierarchy

  • RolesApiCreateRoleRequest

Index

Properties

Properties

body

body: RoleCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiDeleteRoleRequest.html b/interfaces/v2.RolesApiDeleteRoleRequest.html index 5eae799c648..851f7f5223c 100644 --- a/interfaces/v2.RolesApiDeleteRoleRequest.html +++ b/interfaces/v2.RolesApiDeleteRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiDeleteRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiDeleteRoleRequest

Hierarchy

  • RolesApiDeleteRoleRequest

Index

Properties

Properties

roleId

roleId: string
+RolesApiDeleteRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiDeleteRoleRequest

Hierarchy

  • RolesApiDeleteRoleRequest

Index

Properties

Properties

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiGetRoleRequest.html b/interfaces/v2.RolesApiGetRoleRequest.html index 8ea249f3c1c..b9b551375f1 100644 --- a/interfaces/v2.RolesApiGetRoleRequest.html +++ b/interfaces/v2.RolesApiGetRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiGetRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiGetRoleRequest

Hierarchy

  • RolesApiGetRoleRequest

Index

Properties

Properties

roleId

roleId: string
+RolesApiGetRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiGetRoleRequest

Hierarchy

  • RolesApiGetRoleRequest

Index

Properties

Properties

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiListRolePermissionsRequest.html b/interfaces/v2.RolesApiListRolePermissionsRequest.html index 5f225091972..3f930f79be4 100644 --- a/interfaces/v2.RolesApiListRolePermissionsRequest.html +++ b/interfaces/v2.RolesApiListRolePermissionsRequest.html @@ -1,3 +1,3 @@ -RolesApiListRolePermissionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiListRolePermissionsRequest

Hierarchy

  • RolesApiListRolePermissionsRequest

Index

Properties

Properties

roleId

roleId: string
+RolesApiListRolePermissionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiListRolePermissionsRequest

Hierarchy

  • RolesApiListRolePermissionsRequest

Index

Properties

Properties

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiListRoleUsersRequest.html b/interfaces/v2.RolesApiListRoleUsersRequest.html index 099be696a76..f9456752206 100644 --- a/interfaces/v2.RolesApiListRoleUsersRequest.html +++ b/interfaces/v2.RolesApiListRoleUsersRequest.html @@ -1,11 +1,11 @@ -RolesApiListRoleUsersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiListRoleUsersRequest

Hierarchy

  • RolesApiListRoleUsersRequest

Index

Properties

Properties

Optional filter

filter?: string
+RolesApiListRoleUsersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiListRoleUsersRequest

Hierarchy

  • RolesApiListRoleUsersRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter all users by the given string. Defaults to no filtering.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

roleId

roleId: string
+

roleId

roleId: string

The ID of the role.

-

Optional sort

sort?: string
+

Optional sort

sort?: string

User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `email`, `status`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiListRolesRequest.html b/interfaces/v2.RolesApiListRolesRequest.html index 46981749e9d..555a5e065ec 100644 --- a/interfaces/v2.RolesApiListRolesRequest.html +++ b/interfaces/v2.RolesApiListRolesRequest.html @@ -1,9 +1,9 @@ -RolesApiListRolesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiListRolesRequest

Hierarchy

  • RolesApiListRolesRequest

Index

Properties

Properties

Optional filter

filter?: string
+RolesApiListRolesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiListRolesRequest

Hierarchy

  • RolesApiListRolesRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter all roles by the given string.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

Optional sort

sort?: RolesSort
+

Optional sort

sort?: RolesSort

Sort roles depending on the given field. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example: `sort=-name`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiRemovePermissionFromRoleRequest.html b/interfaces/v2.RolesApiRemovePermissionFromRoleRequest.html index 0aef7babe9c..24e7c406297 100644 --- a/interfaces/v2.RolesApiRemovePermissionFromRoleRequest.html +++ b/interfaces/v2.RolesApiRemovePermissionFromRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiRemovePermissionFromRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiRemovePermissionFromRoleRequest

Hierarchy

  • RolesApiRemovePermissionFromRoleRequest

Index

Properties

Properties

body

body: RelationshipToPermission

roleId

roleId: string
+RolesApiRemovePermissionFromRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiRemovePermissionFromRoleRequest

Hierarchy

  • RolesApiRemovePermissionFromRoleRequest

Index

Properties

Properties

body

body: RelationshipToPermission

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiRemoveUserFromRoleRequest.html b/interfaces/v2.RolesApiRemoveUserFromRoleRequest.html index e98d9436eb4..37793d76ec3 100644 --- a/interfaces/v2.RolesApiRemoveUserFromRoleRequest.html +++ b/interfaces/v2.RolesApiRemoveUserFromRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiRemoveUserFromRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiRemoveUserFromRoleRequest

Hierarchy

  • RolesApiRemoveUserFromRoleRequest

Index

Properties

Properties

body

body: RelationshipToUser

roleId

roleId: string
+RolesApiRemoveUserFromRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiRemoveUserFromRoleRequest

Hierarchy

  • RolesApiRemoveUserFromRoleRequest

Index

Properties

Properties

body

body: RelationshipToUser

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.RolesApiUpdateRoleRequest.html b/interfaces/v2.RolesApiUpdateRoleRequest.html index b56790f7ff7..b4d03773305 100644 --- a/interfaces/v2.RolesApiUpdateRoleRequest.html +++ b/interfaces/v2.RolesApiUpdateRoleRequest.html @@ -1,3 +1,3 @@ -RolesApiUpdateRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiUpdateRoleRequest

Hierarchy

  • RolesApiUpdateRoleRequest

Index

Properties

Properties

body

body: RoleUpdateRequest

roleId

roleId: string
+RolesApiUpdateRoleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RolesApiUpdateRoleRequest

Hierarchy

  • RolesApiUpdateRoleRequest

Index

Properties

Properties

body

body: RoleUpdateRequest

roleId

roleId: string

The ID of the role.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityAuthentication.html b/interfaces/v2.SecurityAuthentication.html index ecd2e8afe45..5f3cb4577bd 100644 --- a/interfaces/v2.SecurityAuthentication.html +++ b/interfaces/v2.SecurityAuthentication.html @@ -1,6 +1,6 @@ SecurityAuthentication | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityAuthentication

Interface authentication schemes.

-

Hierarchy

  • SecurityAuthentication

Implemented by

Index

Methods

Methods

applySecurityAuthentication

Hierarchy

  • SecurityAuthentication

Implemented by

Index

Methods

Methods

applySecurityAuthentication

getName

  • getName(): string

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

  • getName(): string

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiCreateSecurityFilterRequest.html b/interfaces/v2.SecurityMonitoringApiCreateSecurityFilterRequest.html index cf17fd98218..ce8c0fad921 100644 --- a/interfaces/v2.SecurityMonitoringApiCreateSecurityFilterRequest.html +++ b/interfaces/v2.SecurityMonitoringApiCreateSecurityFilterRequest.html @@ -1,3 +1,3 @@ -SecurityMonitoringApiCreateSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiCreateSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiCreateSecurityFilterRequest

Index

Properties

Properties

body

body: SecurityFilterCreateRequest
+SecurityMonitoringApiCreateSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiCreateSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiCreateSecurityFilterRequest

Index

Properties

Properties

body

body: SecurityFilterCreateRequest

The definition of the new security filter.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest.html b/interfaces/v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest.html index 1dae2dc8d19..0d9d1b9abd6 100644 --- a/interfaces/v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest.html +++ b/interfaces/v2.SecurityMonitoringApiCreateSecurityMonitoringRuleRequest.html @@ -1 +1 @@ -SecurityMonitoringApiCreateSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiCreateSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiCreateSecurityMonitoringRuleRequest

Index

Properties

Properties

body

body: SecurityMonitoringRuleCreatePayload

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +SecurityMonitoringApiCreateSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiCreateSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiCreateSecurityMonitoringRuleRequest

Index

Properties

Properties

body

body: SecurityMonitoringRuleCreatePayload

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiDeleteSecurityFilterRequest.html b/interfaces/v2.SecurityMonitoringApiDeleteSecurityFilterRequest.html index cf6566b3faa..fba85b12ec0 100644 --- a/interfaces/v2.SecurityMonitoringApiDeleteSecurityFilterRequest.html +++ b/interfaces/v2.SecurityMonitoringApiDeleteSecurityFilterRequest.html @@ -1,3 +1,3 @@ -SecurityMonitoringApiDeleteSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiDeleteSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiDeleteSecurityFilterRequest

Index

Properties

Properties

securityFilterId

securityFilterId: string
+SecurityMonitoringApiDeleteSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiDeleteSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiDeleteSecurityFilterRequest

Index

Properties

Properties

securityFilterId

securityFilterId: string

The ID of the security filter.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest.html b/interfaces/v2.SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest.html index 69a987f8272..8ec39b1e0fa 100644 --- a/interfaces/v2.SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest.html +++ b/interfaces/v2.SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest.html @@ -1,3 +1,3 @@ -SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest

Index

Properties

Properties

ruleId

ruleId: string
+SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiDeleteSecurityMonitoringRuleRequest

Index

Properties

Properties

ruleId

ruleId: string

The ID of the rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiGetSecurityFilterRequest.html b/interfaces/v2.SecurityMonitoringApiGetSecurityFilterRequest.html index 7d74ae833a6..790ee18b3d6 100644 --- a/interfaces/v2.SecurityMonitoringApiGetSecurityFilterRequest.html +++ b/interfaces/v2.SecurityMonitoringApiGetSecurityFilterRequest.html @@ -1,3 +1,3 @@ -SecurityMonitoringApiGetSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiGetSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiGetSecurityFilterRequest

Index

Properties

Properties

securityFilterId

securityFilterId: string
+SecurityMonitoringApiGetSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiGetSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiGetSecurityFilterRequest

Index

Properties

Properties

securityFilterId

securityFilterId: string

The ID of the security filter.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiGetSecurityMonitoringRuleRequest.html b/interfaces/v2.SecurityMonitoringApiGetSecurityMonitoringRuleRequest.html index f5790666d9f..32e38c4b51c 100644 --- a/interfaces/v2.SecurityMonitoringApiGetSecurityMonitoringRuleRequest.html +++ b/interfaces/v2.SecurityMonitoringApiGetSecurityMonitoringRuleRequest.html @@ -1,3 +1,3 @@ -SecurityMonitoringApiGetSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiGetSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiGetSecurityMonitoringRuleRequest

Index

Properties

Properties

ruleId

ruleId: string
+SecurityMonitoringApiGetSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiGetSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiGetSecurityMonitoringRuleRequest

Index

Properties

Properties

ruleId

ruleId: string

The ID of the rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringRulesRequest.html b/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringRulesRequest.html index 4f9d7c14141..432c88c1a16 100644 --- a/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringRulesRequest.html +++ b/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringRulesRequest.html @@ -1,5 +1,5 @@ -SecurityMonitoringApiListSecurityMonitoringRulesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiListSecurityMonitoringRulesRequest

Hierarchy

  • SecurityMonitoringApiListSecurityMonitoringRulesRequest

Index

Properties

Properties

Optional pageNumber

pageNumber?: number
+SecurityMonitoringApiListSecurityMonitoringRulesRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiListSecurityMonitoringRulesRequest

Hierarchy

  • SecurityMonitoringApiListSecurityMonitoringRulesRequest

Index

Properties

Properties

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringSignalsRequest.html b/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringSignalsRequest.html index 6014a5faae8..099c280289f 100644 --- a/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringSignalsRequest.html +++ b/interfaces/v2.SecurityMonitoringApiListSecurityMonitoringSignalsRequest.html @@ -1,13 +1,13 @@ -SecurityMonitoringApiListSecurityMonitoringSignalsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiListSecurityMonitoringSignalsRequest

Hierarchy

  • SecurityMonitoringApiListSecurityMonitoringSignalsRequest

Index

Properties

Properties

Optional filterFrom

filterFrom?: Date
+SecurityMonitoringApiListSecurityMonitoringSignalsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiListSecurityMonitoringSignalsRequest

Hierarchy

  • SecurityMonitoringApiListSecurityMonitoringSignalsRequest

Index

Properties

Properties

Optional filterFrom

filterFrom?: Date

The minimum timestamp for requested security signals.

-

Optional filterQuery

filterQuery?: string
+

Optional filterQuery

filterQuery?: string

The search query for security signals.

-

Optional filterTo

filterTo?: Date
+

Optional filterTo

filterTo?: Date

The maximum timestamp for requested security signals.

-

Optional pageCursor

pageCursor?: string
+

Optional pageCursor

pageCursor?: string

A list of results using the cursor provided in the previous query.

-

Optional pageLimit

pageLimit?: number
+

Optional pageLimit

pageLimit?: number

The maximum number of security signals in the response.

-

Optional sort

sort?: SecurityMonitoringSignalsSort
+

Optional sort

sort?: SecurityMonitoringSignalsSort

The order of the security signals in results.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest.html b/interfaces/v2.SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest.html index f3fe09b14ff..0b38d00a324 100644 --- a/interfaces/v2.SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest.html +++ b/interfaces/v2.SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest.html @@ -1 +1 @@ -SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest

Hierarchy

  • SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest

Index

Properties

Properties

Optional body

body?: SecurityMonitoringSignalListRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest

Hierarchy

  • SecurityMonitoringApiSearchSecurityMonitoringSignalsRequest

Index

Properties

Properties

Optional body

body?: SecurityMonitoringSignalListRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiUpdateSecurityFilterRequest.html b/interfaces/v2.SecurityMonitoringApiUpdateSecurityFilterRequest.html index 6ae03ca4abf..fe7b68c1e2f 100644 --- a/interfaces/v2.SecurityMonitoringApiUpdateSecurityFilterRequest.html +++ b/interfaces/v2.SecurityMonitoringApiUpdateSecurityFilterRequest.html @@ -1,5 +1,5 @@ -SecurityMonitoringApiUpdateSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiUpdateSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiUpdateSecurityFilterRequest

Index

Properties

Properties

body

body: SecurityFilterUpdateRequest
+SecurityMonitoringApiUpdateSecurityFilterRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiUpdateSecurityFilterRequest

Hierarchy

  • SecurityMonitoringApiUpdateSecurityFilterRequest

Index

Properties

Properties

body

body: SecurityFilterUpdateRequest

New definition of the security filter.

-

securityFilterId

securityFilterId: string
+

securityFilterId

securityFilterId: string

The ID of the security filter.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest.html b/interfaces/v2.SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest.html index eaa40ab85db..769079bbcdf 100644 --- a/interfaces/v2.SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest.html +++ b/interfaces/v2.SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest.html @@ -1,3 +1,3 @@ -SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest

Index

Properties

Properties

body

body: SecurityMonitoringRuleUpdatePayload

ruleId

ruleId: string
+SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest

Hierarchy

  • SecurityMonitoringApiUpdateSecurityMonitoringRuleRequest

Index

Properties

Properties

body

body: SecurityMonitoringRuleUpdatePayload

ruleId

ruleId: string

The ID of the rule.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ServiceAccountsApiCreateServiceAccountApplicationKeyRequest.html b/interfaces/v2.ServiceAccountsApiCreateServiceAccountApplicationKeyRequest.html index 4dcd5d08be7..f19a65da5c0 100644 --- a/interfaces/v2.ServiceAccountsApiCreateServiceAccountApplicationKeyRequest.html +++ b/interfaces/v2.ServiceAccountsApiCreateServiceAccountApplicationKeyRequest.html @@ -1,3 +1,3 @@ -ServiceAccountsApiCreateServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiCreateServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiCreateServiceAccountApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKeyCreateRequest

serviceAccountId

serviceAccountId: string
+ServiceAccountsApiCreateServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiCreateServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiCreateServiceAccountApplicationKeyRequest

Index

Properties

Properties

body

body: ApplicationKeyCreateRequest

serviceAccountId

serviceAccountId: string

The ID of the service account.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest.html b/interfaces/v2.ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest.html index b1a85cb712e..d655ff7ccb7 100644 --- a/interfaces/v2.ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest.html +++ b/interfaces/v2.ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest.html @@ -1,5 +1,5 @@ -ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

-

serviceAccountId

serviceAccountId: string
+

serviceAccountId

serviceAccountId: string

The ID of the service account.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ServiceAccountsApiGetServiceAccountApplicationKeyRequest.html b/interfaces/v2.ServiceAccountsApiGetServiceAccountApplicationKeyRequest.html index 573cda5882d..33f31a0e796 100644 --- a/interfaces/v2.ServiceAccountsApiGetServiceAccountApplicationKeyRequest.html +++ b/interfaces/v2.ServiceAccountsApiGetServiceAccountApplicationKeyRequest.html @@ -1,5 +1,5 @@ -ServiceAccountsApiGetServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiGetServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiGetServiceAccountApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+ServiceAccountsApiGetServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiGetServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiGetServiceAccountApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

-

serviceAccountId

serviceAccountId: string
+

serviceAccountId

serviceAccountId: string

The ID of the service account.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ServiceAccountsApiListServiceAccountApplicationKeysRequest.html b/interfaces/v2.ServiceAccountsApiListServiceAccountApplicationKeysRequest.html index 16e90efdc6c..23873a1ea33 100644 --- a/interfaces/v2.ServiceAccountsApiListServiceAccountApplicationKeysRequest.html +++ b/interfaces/v2.ServiceAccountsApiListServiceAccountApplicationKeysRequest.html @@ -1,15 +1,15 @@ -ServiceAccountsApiListServiceAccountApplicationKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiListServiceAccountApplicationKeysRequest

Hierarchy

  • ServiceAccountsApiListServiceAccountApplicationKeysRequest

Index

Properties

Properties

Optional filter

filter?: string
+ServiceAccountsApiListServiceAccountApplicationKeysRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiListServiceAccountApplicationKeysRequest

Hierarchy

  • ServiceAccountsApiListServiceAccountApplicationKeysRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter application keys by the specified string.

-

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string
+

Optional filterCreatedAtEnd

filterCreatedAtEnd?: string

Only include application keys created on or before the specified date.

-

Optional filterCreatedAtStart

filterCreatedAtStart?: string
+

Optional filterCreatedAtStart

filterCreatedAtStart?: string

Only include application keys created on or after the specified date.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

serviceAccountId

serviceAccountId: string
+

serviceAccountId

serviceAccountId: string

The ID of the service account.

-

Optional sort

sort?: ApplicationKeysSort
+

Optional sort

sort?: ApplicationKeysSort

Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest.html b/interfaces/v2.ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest.html index 2ca9a933bbf..2342a567adb 100644 --- a/interfaces/v2.ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest.html +++ b/interfaces/v2.ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest.html @@ -1,5 +1,5 @@ -ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string
+ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest

Hierarchy

  • ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest

Index

Properties

Properties

appKeyId

appKeyId: string

The ID of the application key.

-

body

body: ApplicationKeyUpdateRequest

serviceAccountId

serviceAccountId: string
+

body

body: ApplicationKeyUpdateRequest

serviceAccountId

serviceAccountId: string

The ID of the service account.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.TokenProvider.html b/interfaces/v2.TokenProvider.html index 5cc5beb357a..a7f869668a2 100644 --- a/interfaces/v2.TokenProvider.html +++ b/interfaces/v2.TokenProvider.html @@ -1 +1 @@ -TokenProvider | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenProvider

Hierarchy

  • TokenProvider

Index

Methods

Methods

getToken

  • getToken(): string | Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +TokenProvider | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TokenProvider

Hierarchy

  • TokenProvider

Index

Methods

Methods

getToken

  • getToken(): string | Promise<string>

Legend

  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiCreateServiceAccountRequest.html b/interfaces/v2.UsersApiCreateServiceAccountRequest.html index fda1e3c9805..ba51af605c8 100644 --- a/interfaces/v2.UsersApiCreateServiceAccountRequest.html +++ b/interfaces/v2.UsersApiCreateServiceAccountRequest.html @@ -1 +1 @@ -UsersApiCreateServiceAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiCreateServiceAccountRequest

Hierarchy

  • UsersApiCreateServiceAccountRequest

Index

Properties

Properties

body

body: ServiceAccountCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +UsersApiCreateServiceAccountRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiCreateServiceAccountRequest

Hierarchy

  • UsersApiCreateServiceAccountRequest

Index

Properties

Properties

body

body: ServiceAccountCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiCreateUserRequest.html b/interfaces/v2.UsersApiCreateUserRequest.html index 32c6627bfdd..5dd2c7ceff6 100644 --- a/interfaces/v2.UsersApiCreateUserRequest.html +++ b/interfaces/v2.UsersApiCreateUserRequest.html @@ -1 +1 @@ -UsersApiCreateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiCreateUserRequest

Hierarchy

  • UsersApiCreateUserRequest

Index

Properties

Properties

body

body: UserCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +UsersApiCreateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiCreateUserRequest

Hierarchy

  • UsersApiCreateUserRequest

Index

Properties

Properties

body

body: UserCreateRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiDisableUserRequest.html b/interfaces/v2.UsersApiDisableUserRequest.html index 334e1c57bbb..e4088db2117 100644 --- a/interfaces/v2.UsersApiDisableUserRequest.html +++ b/interfaces/v2.UsersApiDisableUserRequest.html @@ -1,3 +1,3 @@ -UsersApiDisableUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiDisableUserRequest

Hierarchy

  • UsersApiDisableUserRequest

Index

Properties

Properties

userId

userId: string
+UsersApiDisableUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiDisableUserRequest

Hierarchy

  • UsersApiDisableUserRequest

Index

Properties

Properties

userId

userId: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiGetInvitationRequest.html b/interfaces/v2.UsersApiGetInvitationRequest.html index 380f443fb8e..92322f331f5 100644 --- a/interfaces/v2.UsersApiGetInvitationRequest.html +++ b/interfaces/v2.UsersApiGetInvitationRequest.html @@ -1,3 +1,3 @@ -UsersApiGetInvitationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiGetInvitationRequest

Hierarchy

  • UsersApiGetInvitationRequest

Index

Properties

Properties

userInvitationUuid

userInvitationUuid: string
+UsersApiGetInvitationRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiGetInvitationRequest

Hierarchy

  • UsersApiGetInvitationRequest

Index

Properties

Properties

userInvitationUuid

userInvitationUuid: string

The UUID of the user invitation.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiGetUserRequest.html b/interfaces/v2.UsersApiGetUserRequest.html index 376e78834ae..a2ca4de7c57 100644 --- a/interfaces/v2.UsersApiGetUserRequest.html +++ b/interfaces/v2.UsersApiGetUserRequest.html @@ -1,3 +1,3 @@ -UsersApiGetUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiGetUserRequest

Hierarchy

  • UsersApiGetUserRequest

Index

Properties

Properties

userId

userId: string
+UsersApiGetUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiGetUserRequest

Hierarchy

  • UsersApiGetUserRequest

Index

Properties

Properties

userId

userId: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiListUserOrganizationsRequest.html b/interfaces/v2.UsersApiListUserOrganizationsRequest.html index d63d55281a1..61a0729d6d6 100644 --- a/interfaces/v2.UsersApiListUserOrganizationsRequest.html +++ b/interfaces/v2.UsersApiListUserOrganizationsRequest.html @@ -1,3 +1,3 @@ -UsersApiListUserOrganizationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiListUserOrganizationsRequest

Hierarchy

  • UsersApiListUserOrganizationsRequest

Index

Properties

Properties

userId

userId: string
+UsersApiListUserOrganizationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiListUserOrganizationsRequest

Hierarchy

  • UsersApiListUserOrganizationsRequest

Index

Properties

Properties

userId

userId: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiListUserPermissionsRequest.html b/interfaces/v2.UsersApiListUserPermissionsRequest.html index 79a30c40126..2005bc8efe9 100644 --- a/interfaces/v2.UsersApiListUserPermissionsRequest.html +++ b/interfaces/v2.UsersApiListUserPermissionsRequest.html @@ -1,3 +1,3 @@ -UsersApiListUserPermissionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiListUserPermissionsRequest

Hierarchy

  • UsersApiListUserPermissionsRequest

Index

Properties

Properties

userId

userId: string
+UsersApiListUserPermissionsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiListUserPermissionsRequest

Hierarchy

  • UsersApiListUserPermissionsRequest

Index

Properties

Properties

userId

userId: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiListUsersRequest.html b/interfaces/v2.UsersApiListUsersRequest.html index 8bbe89acfe3..4cb9c77180e 100644 --- a/interfaces/v2.UsersApiListUsersRequest.html +++ b/interfaces/v2.UsersApiListUsersRequest.html @@ -1,13 +1,13 @@ -UsersApiListUsersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiListUsersRequest

Hierarchy

  • UsersApiListUsersRequest

Index

Properties

Properties

Optional filter

filter?: string
+UsersApiListUsersRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiListUsersRequest

Hierarchy

  • UsersApiListUsersRequest

Index

Properties

Properties

Optional filter

filter?: string

Filter all users by the given string. Defaults to no filtering.

-

Optional filterStatus

filterStatus?: string
+

Optional filterStatus

filterStatus?: string

Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering.

-

Optional pageNumber

pageNumber?: number
+

Optional pageNumber

pageNumber?: number

Specific page number to return.

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

Size for a given page.

-

Optional sort

sort?: string
+

Optional sort

sort?: string

User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `modified_at`, `user_count`.

-

Optional sortDir

sortDir?: v2.QuerySortOrder
+

Optional sortDir

sortDir?: v2.QuerySortOrder

Direction of sort. Options: `asc`, `desc`.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiSendInvitationsRequest.html b/interfaces/v2.UsersApiSendInvitationsRequest.html index 0a54f83bc91..0e787217da9 100644 --- a/interfaces/v2.UsersApiSendInvitationsRequest.html +++ b/interfaces/v2.UsersApiSendInvitationsRequest.html @@ -1 +1 @@ -UsersApiSendInvitationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiSendInvitationsRequest

Hierarchy

  • UsersApiSendInvitationsRequest

Index

Properties

Properties

body

body: UserInvitationsRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +UsersApiSendInvitationsRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiSendInvitationsRequest

Hierarchy

  • UsersApiSendInvitationsRequest

Index

Properties

Properties

body

body: UserInvitationsRequest

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/v2.UsersApiUpdateUserRequest.html b/interfaces/v2.UsersApiUpdateUserRequest.html index 9773c288970..148287cbf66 100644 --- a/interfaces/v2.UsersApiUpdateUserRequest.html +++ b/interfaces/v2.UsersApiUpdateUserRequest.html @@ -1,3 +1,3 @@ -UsersApiUpdateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiUpdateUserRequest

Hierarchy

  • UsersApiUpdateUserRequest

Index

Properties

Properties

body

body: UserUpdateRequest

userId

userId: string
+UsersApiUpdateUserRequest | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UsersApiUpdateUserRequest

Hierarchy

  • UsersApiUpdateUserRequest

Index

Properties

Properties

body

body: UserUpdateRequest

userId

userId: string

The ID of the user.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html index 16d479f894e..efa732d4a33 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

datadog-api-client-typescript

Index

Namespaces

Variables

Variables

logger

logger: any = ...

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

datadog-api-client-typescript

Index

Namespaces

Variables

Variables

logger

logger: any = ...

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/v1.html b/modules/v1.html index 06ee083d212..ec0664a8e63 100644 --- a/modules/v1.html +++ b/modules/v1.html @@ -1,1233 +1,1233 @@ -v1 | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace v1

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AWSNamespace

AWSNamespace: typeof ELB | typeof APPLICATION_ELB | typeof SQS | typeof RDS | typeof CUSTOM | typeof NETWORK_ELB | typeof LAMBDA
+v1 | datadog-api-client-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace v1

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AWSNamespace

AWSNamespace: typeof ELB | typeof APPLICATION_ELB | typeof SQS | typeof RDS | typeof CUSTOM | typeof NETWORK_ELB | typeof LAMBDA

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

AccessRole

AccessRole: typeof STANDARD | typeof ADMIN | typeof READ_ONLY | typeof ERROR
+

AccessRole

AccessRole: typeof STANDARD | typeof ADMIN | typeof READ_ONLY | typeof ERROR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

AlertGraphWidgetDefinitionType

AlertGraphWidgetDefinitionType: typeof ALERT_GRAPH
+

AlertGraphWidgetDefinitionType

AlertGraphWidgetDefinitionType: typeof ALERT_GRAPH

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

AlertValueWidgetDefinitionType

AlertValueWidgetDefinitionType: typeof ALERT_VALUE
+

AlertValueWidgetDefinitionType

AlertValueWidgetDefinitionType: typeof ALERT_VALUE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ApiKeyConfiguration

ApiKeyConfiguration: string

ApmStatsQueryRowType

ApmStatsQueryRowType: typeof SERVICE | typeof RESOURCE | typeof SPAN
+

ApiKeyConfiguration

ApiKeyConfiguration: string

ApmStatsQueryRowType

ApmStatsQueryRowType: typeof SERVICE | typeof RESOURCE | typeof SPAN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

AuthMethods

AuthMethods: { AuthZ?: v1.SecurityAuthentication; apiKeyAuth?: v1.SecurityAuthentication; apiKeyAuthQuery?: v1.SecurityAuthentication; appKeyAuth?: v1.SecurityAuthentication; appKeyAuthQuery?: v1.SecurityAuthentication }

Type declaration

AuthMethodsConfiguration

AuthMethodsConfiguration: { AuthZ?: v1.OAuth2Configuration; apiKeyAuth?: v1.ApiKeyConfiguration; apiKeyAuthQuery?: v1.ApiKeyConfiguration; appKeyAuth?: v1.ApiKeyConfiguration; appKeyAuthQuery?: v1.ApiKeyConfiguration }

Type declaration

ChangeWidgetDefinitionType

ChangeWidgetDefinitionType: typeof CHANGE
+

AuthMethods

AuthMethods: { AuthZ?: v1.SecurityAuthentication; apiKeyAuth?: v1.SecurityAuthentication; apiKeyAuthQuery?: v1.SecurityAuthentication; appKeyAuth?: v1.SecurityAuthentication; appKeyAuthQuery?: v1.SecurityAuthentication }

Type declaration

AuthMethodsConfiguration

AuthMethodsConfiguration: { AuthZ?: v1.OAuth2Configuration; apiKeyAuth?: v1.ApiKeyConfiguration; apiKeyAuthQuery?: v1.ApiKeyConfiguration; appKeyAuth?: v1.ApiKeyConfiguration; appKeyAuthQuery?: v1.ApiKeyConfiguration }

Type declaration

ChangeWidgetDefinitionType

ChangeWidgetDefinitionType: typeof CHANGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

CheckStatusWidgetDefinitionType

CheckStatusWidgetDefinitionType: typeof CHECK_STATUS
+

CheckStatusWidgetDefinitionType

CheckStatusWidgetDefinitionType: typeof CHECK_STATUS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ContentEncoding

ContentEncoding: typeof GZIP | typeof DEFLATE
+

ContentEncoding

ContentEncoding: typeof GZIP | typeof DEFLATE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

DashboardLayoutType

DashboardLayoutType: typeof ORDERED | typeof FREE
+

DashboardLayoutType

DashboardLayoutType: typeof ORDERED | typeof FREE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

DashboardReflowType

DashboardReflowType: typeof AUTO | typeof FIXED
+

DashboardReflowType

DashboardReflowType: typeof AUTO | typeof FIXED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

DashboardResourceType

DashboardResourceType: typeof DASHBOARD
+

DashboardResourceType

DashboardResourceType: typeof DASHBOARD

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

DistributionWidgetDefinitionType

DistributionWidgetDefinitionType: typeof DISTRIBUTION
+

DistributionWidgetDefinitionType

DistributionWidgetDefinitionType: typeof DISTRIBUTION

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

EventAlertType

EventAlertType: typeof ERROR | typeof WARNING | typeof INFO | typeof SUCCESS | typeof USER_UPDATE | typeof RECOMMENDATION | typeof SNAPSHOT
+

EventAlertType

EventAlertType: typeof ERROR | typeof WARNING | typeof INFO | typeof SUCCESS | typeof USER_UPDATE | typeof RECOMMENDATION | typeof SNAPSHOT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

EventPriority

EventPriority: typeof NORMAL | typeof LOW
+

EventPriority

EventPriority: typeof NORMAL | typeof LOW

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

EventStreamWidgetDefinitionType

EventStreamWidgetDefinitionType: typeof EVENT_STREAM
+

EventStreamWidgetDefinitionType

EventStreamWidgetDefinitionType: typeof EVENT_STREAM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

EventTimelineWidgetDefinitionType

EventTimelineWidgetDefinitionType: typeof EVENT_TIMELINE
+

EventTimelineWidgetDefinitionType

EventTimelineWidgetDefinitionType: typeof EVENT_TIMELINE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionApmDependencyStatName

FormulaAndFunctionApmDependencyStatName: typeof AVG_DURATION | typeof AVG_ROOT_DURATION | typeof AVG_SPANS_PER_TRACE | typeof ERROR_RATE | typeof PCT_EXEC_TIME | typeof PCT_OF_TRACES | typeof TOTAL_TRACES_COUNT
+

FormulaAndFunctionApmDependencyStatName

FormulaAndFunctionApmDependencyStatName: typeof AVG_DURATION | typeof AVG_ROOT_DURATION | typeof AVG_SPANS_PER_TRACE | typeof ERROR_RATE | typeof PCT_EXEC_TIME | typeof PCT_OF_TRACES | typeof TOTAL_TRACES_COUNT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionApmDependencyStatsDataSource

FormulaAndFunctionApmDependencyStatsDataSource: typeof APM_DEPENDENCY_STATS
+

FormulaAndFunctionApmDependencyStatsDataSource

FormulaAndFunctionApmDependencyStatsDataSource: typeof APM_DEPENDENCY_STATS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionApmResourceStatName

FormulaAndFunctionApmResourceStatName: typeof ERRORS | typeof ERROR_RATE | typeof HITS | typeof LATENCY_AVG | typeof LATENCY_MAX | typeof LATENCY_P50 | typeof LATENCY_P75 | typeof LATENCY_P90 | typeof LATENCY_P95 | typeof LATENCY_P99
+

FormulaAndFunctionApmResourceStatName

FormulaAndFunctionApmResourceStatName: typeof ERRORS | typeof ERROR_RATE | typeof HITS | typeof LATENCY_AVG | typeof LATENCY_MAX | typeof LATENCY_P50 | typeof LATENCY_P75 | typeof LATENCY_P90 | typeof LATENCY_P95 | typeof LATENCY_P99

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionApmResourceStatsDataSource

FormulaAndFunctionApmResourceStatsDataSource: typeof APM_RESOURCE_STATS
+

FormulaAndFunctionApmResourceStatsDataSource

FormulaAndFunctionApmResourceStatsDataSource: typeof APM_RESOURCE_STATS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionEventAggregation

FormulaAndFunctionEventAggregation: typeof COUNT | typeof CARDINALITY | typeof MEDIAN | typeof PC75 | typeof PC90 | typeof PC95 | typeof PC98 | typeof PC99 | typeof SUM | typeof MIN | typeof MAX | typeof AVG
+

FormulaAndFunctionEventAggregation

FormulaAndFunctionEventAggregation: typeof COUNT | typeof CARDINALITY | typeof MEDIAN | typeof PC75 | typeof PC90 | typeof PC95 | typeof PC98 | typeof PC99 | typeof SUM | typeof MIN | typeof MAX | typeof AVG

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionEventsDataSource

FormulaAndFunctionEventsDataSource: typeof LOGS | typeof SPANS | typeof NETWORK | typeof RUM | typeof SECURITY_SIGNALS | typeof PROFILES | typeof AUDIT | typeof EVENTS
+

FormulaAndFunctionEventsDataSource

FormulaAndFunctionEventsDataSource: typeof LOGS | typeof SPANS | typeof NETWORK | typeof RUM | typeof SECURITY_SIGNALS | typeof PROFILES | typeof AUDIT | typeof EVENTS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionMetricAggregation

FormulaAndFunctionMetricAggregation: typeof AVG | typeof MIN | typeof MAX | typeof SUM | typeof LAST | typeof AREA | typeof L2NORM | typeof PERCENTILE
+

FormulaAndFunctionMetricAggregation

FormulaAndFunctionMetricAggregation: typeof AVG | typeof MIN | typeof MAX | typeof SUM | typeof LAST | typeof AREA | typeof L2NORM | typeof PERCENTILE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionMetricDataSource

FormulaAndFunctionMetricDataSource: typeof METRICS
+

FormulaAndFunctionMetricDataSource

FormulaAndFunctionMetricDataSource: typeof METRICS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionProcessQueryDataSource

FormulaAndFunctionProcessQueryDataSource: typeof PROCESS | typeof CONTAINER
+

FormulaAndFunctionProcessQueryDataSource

FormulaAndFunctionProcessQueryDataSource: typeof PROCESS | typeof CONTAINER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FormulaAndFunctionQueryDefinition

FormulaAndFunctionQueryDefinition: FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionProcessQueryDefinition | UnparsedObject
+

FormulaAndFunctionQueryDefinition

FormulaAndFunctionQueryDefinition: FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionProcessQueryDefinition | UnparsedObject

A formula and function query.

-

FormulaAndFunctionResponseFormat

FormulaAndFunctionResponseFormat: typeof TIMESERIES | typeof SCALAR
+

FormulaAndFunctionResponseFormat

FormulaAndFunctionResponseFormat: typeof TIMESERIES | typeof SCALAR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FreeTextWidgetDefinitionType

FreeTextWidgetDefinitionType: typeof FREE_TEXT
+

FreeTextWidgetDefinitionType

FreeTextWidgetDefinitionType: typeof FREE_TEXT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FunnelRequestType

FunnelRequestType: typeof FUNNEL
+

FunnelRequestType

FunnelRequestType: typeof FUNNEL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FunnelSource

FunnelSource: typeof RUM
+

FunnelSource

FunnelSource: typeof RUM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

FunnelWidgetDefinitionType

FunnelWidgetDefinitionType: typeof FUNNEL
+

FunnelWidgetDefinitionType

FunnelWidgetDefinitionType: typeof FUNNEL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

GeomapWidgetDefinitionType

GeomapWidgetDefinitionType: typeof GEOMAP
+

GeomapWidgetDefinitionType

GeomapWidgetDefinitionType: typeof GEOMAP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

GroupWidgetDefinitionType

GroupWidgetDefinitionType: typeof GROUP
+

GroupWidgetDefinitionType

GroupWidgetDefinitionType: typeof GROUP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

HTTPMethod

HTTPMethod: typeof GET | typeof POST | typeof PATCH | typeof PUT | typeof DELETE | typeof HEAD | typeof OPTIONS
+

HTTPMethod

HTTPMethod: typeof GET | typeof POST | typeof PATCH | typeof PUT | typeof DELETE | typeof HEAD | typeof OPTIONS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

HeatMapWidgetDefinitionType

HeatMapWidgetDefinitionType: typeof HEATMAP
+

HeatMapWidgetDefinitionType

HeatMapWidgetDefinitionType: typeof HEATMAP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

HostMapWidgetDefinitionType

HostMapWidgetDefinitionType: typeof HOSTMAP
+

HostMapWidgetDefinitionType

HostMapWidgetDefinitionType: typeof HOSTMAP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

HourlyUsageAttributionUsageType

HourlyUsageAttributionUsageType: typeof API_USAGE | typeof APM_HOST_USAGE | typeof BROWSER_USAGE | typeof CONTAINER_USAGE | typeof CUSTOM_TIMESERIES_USAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof FARGATE_USAGE | typeof FUNCTIONS_USAGE | typeof INDEXED_LOGS_USAGE | typeof INFRA_HOST_USAGE | typeof INVOCATIONS_USAGE | typeof NPM_HOST_USAGE | typeof PROFILED_CONTAINER_USAGE | typeof PROFILED_HOST_USAGE | typeof SNMP_USAGE
+

HourlyUsageAttributionUsageType

HourlyUsageAttributionUsageType: typeof API_USAGE | typeof APM_HOST_USAGE | typeof BROWSER_USAGE | typeof CONTAINER_USAGE | typeof CUSTOM_TIMESERIES_USAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof FARGATE_USAGE | typeof FUNCTIONS_USAGE | typeof INDEXED_LOGS_USAGE | typeof INFRA_HOST_USAGE | typeof INVOCATIONS_USAGE | typeof NPM_HOST_USAGE | typeof PROFILED_CONTAINER_USAGE | typeof PROFILED_HOST_USAGE | typeof SNMP_USAGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

HttpBasicConfiguration

HttpBasicConfiguration: { password: string; username: string }

Type declaration

  • password: string
  • username: string

HttpBearerConfiguration

HttpBearerConfiguration: { tokenProvider: v1.TokenProvider }

Type declaration

HttpFile

HttpFile: { data: Buffer; name: string }
+

HttpBasicConfiguration

HttpBasicConfiguration: { password: string; username: string }

Type declaration

  • password: string
  • username: string

HttpBearerConfiguration

HttpBearerConfiguration: { tokenProvider: v1.TokenProvider }

Type declaration

HttpFile

HttpFile: { data: Buffer; name: string }

Represents an HTTP file which will be transferred from or to a server.

-

Type declaration

  • data: Buffer
  • name: string

IFrameWidgetDefinitionType

IFrameWidgetDefinitionType: typeof IFRAME
+

Type declaration

  • data: Buffer
  • name: string

IFrameWidgetDefinitionType

IFrameWidgetDefinitionType: typeof IFRAME

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ImageWidgetDefinitionType

ImageWidgetDefinitionType: typeof IMAGE
+

ImageWidgetDefinitionType

ImageWidgetDefinitionType: typeof IMAGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ListStreamColumnWidth

ListStreamColumnWidth: typeof AUTO | typeof COMPACT | typeof FULL
+

ListStreamColumnWidth

ListStreamColumnWidth: typeof AUTO | typeof COMPACT | typeof FULL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ListStreamResponseFormat

ListStreamResponseFormat: typeof EVENT_LIST
+

ListStreamResponseFormat

ListStreamResponseFormat: typeof EVENT_LIST

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ListStreamSource

ListStreamSource: typeof ISSUE_STREAM | typeof LOGS_STREAM | typeof AUDIT_STREAM
+

ListStreamSource

ListStreamSource: typeof ISSUE_STREAM | typeof LOGS_STREAM | typeof AUDIT_STREAM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ListStreamWidgetDefinitionType

ListStreamWidgetDefinitionType: typeof LIST_STREAM
+

ListStreamWidgetDefinitionType

ListStreamWidgetDefinitionType: typeof LIST_STREAM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogStreamWidgetDefinitionType

LogStreamWidgetDefinitionType: typeof LOG_STREAM
+

LogStreamWidgetDefinitionType

LogStreamWidgetDefinitionType: typeof LOG_STREAM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsArithmeticProcessorType

LogsArithmeticProcessorType: typeof ARITHMETIC_PROCESSOR
+

LogsArithmeticProcessorType

LogsArithmeticProcessorType: typeof ARITHMETIC_PROCESSOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsAttributeRemapperType

LogsAttributeRemapperType: typeof ATTRIBUTE_REMAPPER
+

LogsAttributeRemapperType

LogsAttributeRemapperType: typeof ATTRIBUTE_REMAPPER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsCategoryProcessorType

LogsCategoryProcessorType: typeof CATEGORY_PROCESSOR
+

LogsCategoryProcessorType

LogsCategoryProcessorType: typeof CATEGORY_PROCESSOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsDateRemapperType

LogsDateRemapperType: typeof DATE_REMAPPER
+

LogsDateRemapperType

LogsDateRemapperType: typeof DATE_REMAPPER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsGeoIPParserType

LogsGeoIPParserType: typeof GEO_IP_PARSER
+

LogsGeoIPParserType

LogsGeoIPParserType: typeof GEO_IP_PARSER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsGrokParserType

LogsGrokParserType: typeof GROK_PARSER
+

LogsGrokParserType

LogsGrokParserType: typeof GROK_PARSER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsLookupProcessorType

LogsLookupProcessorType: typeof LOOKUP_PROCESSOR
+

LogsLookupProcessorType

LogsLookupProcessorType: typeof LOOKUP_PROCESSOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsMessageRemapperType

LogsMessageRemapperType: typeof MESSAGE_REMAPPER
+

LogsMessageRemapperType

LogsMessageRemapperType: typeof MESSAGE_REMAPPER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsPipelineProcessorType

LogsPipelineProcessorType: typeof PIPELINE
+

LogsPipelineProcessorType

LogsPipelineProcessorType: typeof PIPELINE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsProcessor

LogsProcessor: LogsArithmeticProcessor | LogsAttributeRemapper | LogsCategoryProcessor | LogsDateRemapper | LogsGeoIPParser | LogsGrokParser | LogsLookupProcessor | LogsMessageRemapper | LogsPipelineProcessor | LogsServiceRemapper | LogsStatusRemapper | LogsStringBuilderProcessor | LogsTraceRemapper | LogsURLParser | LogsUserAgentParser | UnparsedObject
+

LogsProcessor

LogsProcessor: LogsArithmeticProcessor | LogsAttributeRemapper | LogsCategoryProcessor | LogsDateRemapper | LogsGeoIPParser | LogsGrokParser | LogsLookupProcessor | LogsMessageRemapper | LogsPipelineProcessor | LogsServiceRemapper | LogsStatusRemapper | LogsStringBuilderProcessor | LogsTraceRemapper | LogsURLParser | LogsUserAgentParser | UnparsedObject

Definition of a logs processor.

-

LogsServiceRemapperType

LogsServiceRemapperType: typeof SERVICE_REMAPPER
+

LogsServiceRemapperType

LogsServiceRemapperType: typeof SERVICE_REMAPPER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsSort

LogsSort: typeof TIME_ASCENDING | typeof TIME_DESCENDING
+

LogsSort

LogsSort: typeof TIME_ASCENDING | typeof TIME_DESCENDING

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsStatusRemapperType

LogsStatusRemapperType: typeof STATUS_REMAPPER
+

LogsStatusRemapperType

LogsStatusRemapperType: typeof STATUS_REMAPPER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsStringBuilderProcessorType

LogsStringBuilderProcessorType: typeof STRING_BUILDER_PROCESSOR
+

LogsStringBuilderProcessorType

LogsStringBuilderProcessorType: typeof STRING_BUILDER_PROCESSOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsTraceRemapperType

LogsTraceRemapperType: typeof TRACE_ID_REMAPPER
+

LogsTraceRemapperType

LogsTraceRemapperType: typeof TRACE_ID_REMAPPER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsURLParserType

LogsURLParserType: typeof URL_PARSER
+

LogsURLParserType

LogsURLParserType: typeof URL_PARSER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

LogsUserAgentParserType

LogsUserAgentParserType: typeof USER_AGENT_PARSER
+

LogsUserAgentParserType

LogsUserAgentParserType: typeof USER_AGENT_PARSER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MetricContentEncoding

MetricContentEncoding: typeof DEFLATE
+

MetricContentEncoding

MetricContentEncoding: typeof DEFLATE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorDeviceID

MonitorDeviceID: typeof LAPTOP_LARGE | typeof TABLET | typeof MOBILE_SMALL | typeof CHROME_LAPTOP_LARGE | typeof CHROME_TABLET | typeof CHROME_MOBILE_SMALL | typeof FIREFOX_LAPTOP_LARGE | typeof FIREFOX_TABLET | typeof FIREFOX_MOBILE_SMALL
+

MonitorDeviceID

MonitorDeviceID: typeof LAPTOP_LARGE | typeof TABLET | typeof MOBILE_SMALL | typeof CHROME_LAPTOP_LARGE | typeof CHROME_TABLET | typeof CHROME_MOBILE_SMALL | typeof FIREFOX_LAPTOP_LARGE | typeof FIREFOX_TABLET | typeof FIREFOX_MOBILE_SMALL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorFormulaAndFunctionEventAggregation

MonitorFormulaAndFunctionEventAggregation: typeof COUNT | typeof CARDINALITY | typeof MEDIAN | typeof PC75 | typeof PC90 | typeof PC95 | typeof PC98 | typeof PC99 | typeof SUM | typeof MIN | typeof MAX | typeof AVG
+

MonitorFormulaAndFunctionEventAggregation

MonitorFormulaAndFunctionEventAggregation: typeof COUNT | typeof CARDINALITY | typeof MEDIAN | typeof PC75 | typeof PC90 | typeof PC95 | typeof PC98 | typeof PC99 | typeof SUM | typeof MIN | typeof MAX | typeof AVG

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorFormulaAndFunctionEventsDataSource

MonitorFormulaAndFunctionEventsDataSource: typeof RUM
+

MonitorFormulaAndFunctionEventsDataSource

MonitorFormulaAndFunctionEventsDataSource: typeof RUM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorFormulaAndFunctionQueryDefinition

MonitorFormulaAndFunctionQueryDefinition: MonitorFormulaAndFunctionEventQueryDefinition | UnparsedObject
+

MonitorFormulaAndFunctionQueryDefinition

MonitorFormulaAndFunctionQueryDefinition: MonitorFormulaAndFunctionEventQueryDefinition | UnparsedObject

A formula and function query.

-

MonitorOverallStates

MonitorOverallStates: typeof ALERT | typeof IGNORED | typeof NO_DATA | typeof OK | typeof SKIPPED | typeof UNKNOWN | typeof WARN
+

MonitorOverallStates

MonitorOverallStates: typeof ALERT | typeof IGNORED | typeof NO_DATA | typeof OK | typeof SKIPPED | typeof UNKNOWN | typeof WARN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorRenotifyStatusType

MonitorRenotifyStatusType: typeof ALERT | typeof WARN | typeof NO_DATA
+

MonitorRenotifyStatusType

MonitorRenotifyStatusType: typeof ALERT | typeof WARN | typeof NO_DATA

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorSummaryWidgetDefinitionType

MonitorSummaryWidgetDefinitionType: typeof MANAGE_STATUS
+

MonitorSummaryWidgetDefinitionType

MonitorSummaryWidgetDefinitionType: typeof MANAGE_STATUS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonitorType

MonitorType: typeof COMPOSITE | typeof EVENT_ALERT | typeof LOG_ALERT | typeof METRIC_ALERT | typeof PROCESS_ALERT | typeof QUERY_ALERT | typeof RUM_ALERT | typeof SERVICE_CHECK | typeof SYNTHETICS_ALERT | typeof TRACE_ANALYTICS_ALERT | typeof SLO_ALERT | typeof EVENT_V2_ALERT | typeof AUDIT_ALERT | typeof CI_PIPELINES_ALERT
+

MonitorType

MonitorType: typeof COMPOSITE | typeof EVENT_ALERT | typeof LOG_ALERT | typeof METRIC_ALERT | typeof PROCESS_ALERT | typeof QUERY_ALERT | typeof RUM_ALERT | typeof SERVICE_CHECK | typeof SYNTHETICS_ALERT | typeof TRACE_ANALYTICS_ALERT | typeof SLO_ALERT | typeof EVENT_V2_ALERT | typeof AUDIT_ALERT | typeof CI_PIPELINES_ALERT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

MonthlyUsageAttributionSupportedMetrics

MonthlyUsageAttributionSupportedMetrics: typeof API_USAGE | typeof API_PERCENTAGE | typeof APM_HOST_USAGE | typeof APM_HOST_PERCENTAGE | typeof BROWSER_USAGE | typeof BROWSER_PERCENTAGE | typeof CONTAINER_USAGE | typeof CONTAINER_PERCENTAGE | typeof CUSTOM_TIMESERIES_USAGE | typeof CUSTOM_TIMESERIES_PERCENTAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof ESTIMATED_INDEXED_LOGS_PERCENTAGE | typeof FARGATE_USAGE | typeof FARGATE_PERCENTAGE | typeof FUNCTIONS_USAGE | typeof FUNCTIONS_PERCENTAGE | typeof INDEXED_LOGS_USAGE | typeof INDEXED_LOGS_PERCENTAGE | typeof INFRA_HOST_USAGE | typeof INFRA_HOST_PERCENTAGE | typeof INVOCATIONS_USAGE | typeof INVOCATIONS_PERCENTAGE | typeof NPM_HOST_USAGE | typeof NPM_HOST_PERCENTAGE | typeof PROFILED_CONTAINER_USAGE | typeof PROFILED_CONTAINER_PERCENTAGE | typeof PROFILED_HOST_USAGE | typeof PROFILED_HOST_PERCENTAGE | typeof SNMP_USAGE | typeof SNMP_PERCENTAGE | typeof ALL
+

MonthlyUsageAttributionSupportedMetrics

MonthlyUsageAttributionSupportedMetrics: typeof API_USAGE | typeof API_PERCENTAGE | typeof APM_HOST_USAGE | typeof APM_HOST_PERCENTAGE | typeof BROWSER_USAGE | typeof BROWSER_PERCENTAGE | typeof CONTAINER_USAGE | typeof CONTAINER_PERCENTAGE | typeof CUSTOM_TIMESERIES_USAGE | typeof CUSTOM_TIMESERIES_PERCENTAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof ESTIMATED_INDEXED_LOGS_PERCENTAGE | typeof FARGATE_USAGE | typeof FARGATE_PERCENTAGE | typeof FUNCTIONS_USAGE | typeof FUNCTIONS_PERCENTAGE | typeof INDEXED_LOGS_USAGE | typeof INDEXED_LOGS_PERCENTAGE | typeof INFRA_HOST_USAGE | typeof INFRA_HOST_PERCENTAGE | typeof INVOCATIONS_USAGE | typeof INVOCATIONS_PERCENTAGE | typeof NPM_HOST_USAGE | typeof NPM_HOST_PERCENTAGE | typeof PROFILED_CONTAINER_USAGE | typeof PROFILED_CONTAINER_PERCENTAGE | typeof PROFILED_HOST_USAGE | typeof PROFILED_HOST_PERCENTAGE | typeof SNMP_USAGE | typeof SNMP_PERCENTAGE | typeof ALL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NoteWidgetDefinitionType

NoteWidgetDefinitionType: typeof NOTE
+

NoteWidgetDefinitionType

NoteWidgetDefinitionType: typeof NOTE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookCellCreateRequestAttributes

NotebookCellCreateRequestAttributes: NotebookDistributionCellAttributes | NotebookHeatMapCellAttributes | NotebookLogStreamCellAttributes | NotebookMarkdownCellAttributes | NotebookTimeseriesCellAttributes | NotebookToplistCellAttributes | UnparsedObject
+

NotebookCellCreateRequestAttributes

NotebookCellCreateRequestAttributes: NotebookDistributionCellAttributes | NotebookHeatMapCellAttributes | NotebookLogStreamCellAttributes | NotebookMarkdownCellAttributes | NotebookTimeseriesCellAttributes | NotebookToplistCellAttributes | UnparsedObject

The attributes of a notebook cell in create cell request. Valid cell types are markdown, timeseries, toplist, heatmap, distribution, log_stream. More information on each graph visualization type.

-

NotebookCellResourceType

NotebookCellResourceType: typeof NOTEBOOK_CELLS
+

NotebookCellResourceType

NotebookCellResourceType: typeof NOTEBOOK_CELLS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookCellResponseAttributes

NotebookCellResponseAttributes: NotebookDistributionCellAttributes | NotebookHeatMapCellAttributes | NotebookLogStreamCellAttributes | NotebookMarkdownCellAttributes | NotebookTimeseriesCellAttributes | NotebookToplistCellAttributes | UnparsedObject
+

NotebookCellResponseAttributes

NotebookCellResponseAttributes: NotebookDistributionCellAttributes | NotebookHeatMapCellAttributes | NotebookLogStreamCellAttributes | NotebookMarkdownCellAttributes | NotebookTimeseriesCellAttributes | NotebookToplistCellAttributes | UnparsedObject

The attributes of a notebook cell response. Valid cell types are markdown, timeseries, toplist, heatmap, distribution, log_stream. More information on each graph visualization type.

-

NotebookCellTime

NotebookCellTime: NotebookAbsoluteTime | NotebookRelativeTime | UnparsedObject
+

NotebookCellTime

NotebookCellTime: NotebookAbsoluteTime | NotebookRelativeTime | UnparsedObject

Timeframe for the notebook cell. When 'null', the notebook global time is used.

-

NotebookCellUpdateRequestAttributes

NotebookCellUpdateRequestAttributes: NotebookDistributionCellAttributes | NotebookHeatMapCellAttributes | NotebookLogStreamCellAttributes | NotebookMarkdownCellAttributes | NotebookTimeseriesCellAttributes | NotebookToplistCellAttributes | UnparsedObject
+

NotebookCellUpdateRequestAttributes

NotebookCellUpdateRequestAttributes: NotebookDistributionCellAttributes | NotebookHeatMapCellAttributes | NotebookLogStreamCellAttributes | NotebookMarkdownCellAttributes | NotebookTimeseriesCellAttributes | NotebookToplistCellAttributes | UnparsedObject

The attributes of a notebook cell in update cell request. Valid cell types are markdown, timeseries, toplist, heatmap, distribution, log_stream. More information on each graph visualization type.

-

NotebookGlobalTime

NotebookGlobalTime: NotebookAbsoluteTime | NotebookRelativeTime | UnparsedObject
+

NotebookGlobalTime

NotebookGlobalTime: NotebookAbsoluteTime | NotebookRelativeTime | UnparsedObject

Notebook global timeframe.

-

NotebookGraphSize

NotebookGraphSize: typeof EXTRA_SMALL | typeof SMALL | typeof MEDIUM | typeof LARGE | typeof EXTRA_LARGE
+

NotebookGraphSize

NotebookGraphSize: typeof EXTRA_SMALL | typeof SMALL | typeof MEDIUM | typeof LARGE | typeof EXTRA_LARGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookMarkdownCellDefinitionType

NotebookMarkdownCellDefinitionType: typeof MARKDOWN
+

NotebookMarkdownCellDefinitionType

NotebookMarkdownCellDefinitionType: typeof MARKDOWN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookMetadataType

NotebookMetadataType: typeof POSTMORTEM | typeof RUNBOOK | typeof INVESTIGATION | typeof DOCUMENTATION | typeof REPORT
+

NotebookMetadataType

NotebookMetadataType: typeof POSTMORTEM | typeof RUNBOOK | typeof INVESTIGATION | typeof DOCUMENTATION | typeof REPORT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookResourceType

NotebookResourceType: typeof NOTEBOOKS
+

NotebookResourceType

NotebookResourceType: typeof NOTEBOOKS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookStatus

NotebookStatus: typeof PUBLISHED
+

NotebookStatus

NotebookStatus: typeof PUBLISHED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

NotebookUpdateCell

NotebookUpdateCell: NotebookCellCreateRequest | NotebookCellUpdateRequest | UnparsedObject
+

NotebookUpdateCell

NotebookUpdateCell: NotebookCellCreateRequest | NotebookCellUpdateRequest | UnparsedObject

Updating a notebook can either insert new cell(s) or update existing cell(s) by including the cell id. To delete existing cell(s), simply omit it from the list of cells.

-

OAuth2Configuration

OAuth2Configuration: { accessToken: string }

Type declaration

  • accessToken: string

QuerySortOrder

QuerySortOrder: typeof ASC | typeof DESC
+

OAuth2Configuration

OAuth2Configuration: { accessToken: string }

Type declaration

  • accessToken: string

QuerySortOrder

QuerySortOrder: typeof ASC | typeof DESC

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

QueryValueWidgetDefinitionType

QueryValueWidgetDefinitionType: typeof QUERY_VALUE
+

QueryValueWidgetDefinitionType

QueryValueWidgetDefinitionType: typeof QUERY_VALUE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

RequestBody

RequestBody: undefined | string | Buffer | FormData
+

RequestBody

RequestBody: undefined | string | Buffer | FormData

Represents the body of an outgoing HTTP request.

-

SLOCorrectionCategory

SLOCorrectionCategory: typeof SCHEDULED_MAINTENANCE | typeof OUTSIDE_BUSINESS_HOURS | typeof DEPLOYMENT | typeof OTHER
+

SLOCorrectionCategory

SLOCorrectionCategory: typeof SCHEDULED_MAINTENANCE | typeof OUTSIDE_BUSINESS_HOURS | typeof DEPLOYMENT | typeof OTHER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SLOCorrectionType

SLOCorrectionType: typeof CORRECTION
+

SLOCorrectionType

SLOCorrectionType: typeof CORRECTION

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SLOErrorTimeframe

SLOErrorTimeframe: typeof SEVEN_DAYS | typeof THIRTY_DAYS | typeof NINETY_DAYS | typeof ALL
+

SLOErrorTimeframe

SLOErrorTimeframe: typeof SEVEN_DAYS | typeof THIRTY_DAYS | typeof NINETY_DAYS | typeof ALL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SLOTimeframe

SLOTimeframe: typeof SEVEN_DAYS | typeof THIRTY_DAYS | typeof NINETY_DAYS | typeof CUSTOM
+

SLOTimeframe

SLOTimeframe: typeof SEVEN_DAYS | typeof THIRTY_DAYS | typeof NINETY_DAYS | typeof CUSTOM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SLOType

SLOType: typeof METRIC | typeof MONITOR
+

SLOType

SLOType: typeof METRIC | typeof MONITOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SLOTypeNumeric

SLOTypeNumeric: typeof MONITOR | typeof METRIC
+

SLOTypeNumeric

SLOTypeNumeric: typeof MONITOR | typeof METRIC

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SLOWidgetDefinitionType

SLOWidgetDefinitionType: typeof SLO
+

SLOWidgetDefinitionType

SLOWidgetDefinitionType: typeof SLO

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ScatterPlotWidgetDefinitionType

ScatterPlotWidgetDefinitionType: typeof SCATTERPLOT
+

ScatterPlotWidgetDefinitionType

ScatterPlotWidgetDefinitionType: typeof SCATTERPLOT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ScatterplotDimension

ScatterplotDimension: typeof X | typeof Y | typeof RADIUS | typeof COLOR
+

ScatterplotDimension

ScatterplotDimension: typeof X | typeof Y | typeof RADIUS | typeof COLOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ScatterplotWidgetAggregator

ScatterplotWidgetAggregator: typeof AVERAGE | typeof LAST | typeof MAXIMUM | typeof MINIMUM | typeof SUM
+

ScatterplotWidgetAggregator

ScatterplotWidgetAggregator: typeof AVERAGE | typeof LAST | typeof MAXIMUM | typeof MINIMUM | typeof SUM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ServiceCheckStatus

ServiceCheckStatus: typeof OK | typeof WARNING | typeof CRITICAL | typeof UNKNOWN
+

ServiceCheckStatus

ServiceCheckStatus: typeof OK | typeof WARNING | typeof CRITICAL | typeof UNKNOWN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ServiceMapWidgetDefinitionType

ServiceMapWidgetDefinitionType: typeof SERVICEMAP
+

ServiceMapWidgetDefinitionType

ServiceMapWidgetDefinitionType: typeof SERVICEMAP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ServiceSummaryWidgetDefinitionType

ServiceSummaryWidgetDefinitionType: typeof TRACE_SERVICE
+

ServiceSummaryWidgetDefinitionType

ServiceSummaryWidgetDefinitionType: typeof TRACE_SERVICE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SunburstWidgetDefinitionType

SunburstWidgetDefinitionType: typeof SUNBURST
+

SunburstWidgetDefinitionType

SunburstWidgetDefinitionType: typeof SUNBURST

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SunburstWidgetLegend

SunburstWidgetLegend: SunburstWidgetLegendInlineAutomatic | SunburstWidgetLegendTable | UnparsedObject
+

SunburstWidgetLegend

SunburstWidgetLegend: SunburstWidgetLegendInlineAutomatic | SunburstWidgetLegendTable | UnparsedObject

Configuration of the legend.

-

SunburstWidgetLegendInlineAutomaticType

SunburstWidgetLegendInlineAutomaticType: typeof INLINE | typeof AUTOMATIC
+

SunburstWidgetLegendInlineAutomaticType

SunburstWidgetLegendInlineAutomaticType: typeof INLINE | typeof AUTOMATIC

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SunburstWidgetLegendTableType

SunburstWidgetLegendTableType: typeof TABLE | typeof NONE
+

SunburstWidgetLegendTableType

SunburstWidgetLegendTableType: typeof TABLE | typeof NONE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsAPIStepSubtype

SyntheticsAPIStepSubtype: typeof HTTP
+

SyntheticsAPIStepSubtype

SyntheticsAPIStepSubtype: typeof HTTP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsAPITestType

SyntheticsAPITestType: typeof API
+

SyntheticsAPITestType

SyntheticsAPITestType: typeof API

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsApiTestFailureCode

SyntheticsApiTestFailureCode: typeof BODY_TOO_LARGE | typeof DENIED | typeof TOO_MANY_REDIRECTS | typeof AUTHENTICATION_ERROR | typeof DECRYPTION | typeof INVALID_CHAR_IN_HEADER | typeof HEADER_TOO_LARGE | typeof HEADERS_INCOMPATIBLE_CONTENT_LENGTH | typeof INVALID_REQUEST | typeof REQUIRES_UPDATE | typeof UNESCAPED_CHARACTERS_IN_REQUEST_PATH | typeof MALFORMED_RESPONSE | typeof INCORRECT_ASSERTION | typeof CONNREFUSED | typeof CONNRESET | typeof DNS | typeof HOSTUNREACH | typeof NETUNREACH | typeof TIMEOUT | typeof SSL | typeof OCSP | typeof INVALID_TEST | typeof TUNNEL | typeof WEBSOCKET | typeof UNKNOWN | typeof INTERNAL_ERROR
+

SyntheticsApiTestFailureCode

SyntheticsApiTestFailureCode: typeof BODY_TOO_LARGE | typeof DENIED | typeof TOO_MANY_REDIRECTS | typeof AUTHENTICATION_ERROR | typeof DECRYPTION | typeof INVALID_CHAR_IN_HEADER | typeof HEADER_TOO_LARGE | typeof HEADERS_INCOMPATIBLE_CONTENT_LENGTH | typeof INVALID_REQUEST | typeof REQUIRES_UPDATE | typeof UNESCAPED_CHARACTERS_IN_REQUEST_PATH | typeof MALFORMED_RESPONSE | typeof INCORRECT_ASSERTION | typeof CONNREFUSED | typeof CONNRESET | typeof DNS | typeof HOSTUNREACH | typeof NETUNREACH | typeof TIMEOUT | typeof SSL | typeof OCSP | typeof INVALID_TEST | typeof TUNNEL | typeof WEBSOCKET | typeof UNKNOWN | typeof INTERNAL_ERROR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsAssertion

SyntheticsAssertion: SyntheticsAssertionJSONPathTarget | SyntheticsAssertionTarget | UnparsedObject
+

SyntheticsAssertion

SyntheticsAssertion: SyntheticsAssertionJSONPathTarget | SyntheticsAssertionTarget | UnparsedObject

Object describing the assertions type, their associated operator, which property they apply, and upon which target.

-

SyntheticsAssertionJSONPathOperator

SyntheticsAssertionJSONPathOperator: typeof VALIDATES_JSON_PATH
+

SyntheticsAssertionJSONPathOperator

SyntheticsAssertionJSONPathOperator: typeof VALIDATES_JSON_PATH

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsAssertionOperator

SyntheticsAssertionOperator: typeof CONTAINS | typeof DOES_NOT_CONTAIN | typeof IS | typeof IS_NOT | typeof LESS_THAN | typeof LESS_THAN_OR_EQUAL | typeof MORE_THAN | typeof MORE_THAN_OR_EQUAL | typeof MATCHES | typeof DOES_NOT_MATCH | typeof VALIDATES | typeof IS_IN_MORE_DAYS_THAN | typeof IS_IN_LESS_DAYS_THAN
+

SyntheticsAssertionOperator

SyntheticsAssertionOperator: typeof CONTAINS | typeof DOES_NOT_CONTAIN | typeof IS | typeof IS_NOT | typeof LESS_THAN | typeof LESS_THAN_OR_EQUAL | typeof MORE_THAN | typeof MORE_THAN_OR_EQUAL | typeof MATCHES | typeof DOES_NOT_MATCH | typeof VALIDATES | typeof IS_IN_MORE_DAYS_THAN | typeof IS_IN_LESS_DAYS_THAN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsAssertionType

SyntheticsAssertionType: typeof BODY | typeof HEADER | typeof STATUS_CODE | typeof CERTIFICATE | typeof RESPONSE_TIME | typeof PROPERTY | typeof RECORD_EVERY | typeof RECORD_SOME | typeof TLS_VERSION | typeof MIN_TLS_VERSION | typeof LATENCY | typeof PACKET_LOSS_PERCENTAGE | typeof PACKETS_RECEIVED | typeof NETWORK_HOP | typeof RECEIVED_MESSAGE
+

SyntheticsAssertionType

SyntheticsAssertionType: typeof BODY | typeof HEADER | typeof STATUS_CODE | typeof CERTIFICATE | typeof RESPONSE_TIME | typeof PROPERTY | typeof RECORD_EVERY | typeof RECORD_SOME | typeof TLS_VERSION | typeof MIN_TLS_VERSION | typeof LATENCY | typeof PACKET_LOSS_PERCENTAGE | typeof PACKETS_RECEIVED | typeof NETWORK_HOP | typeof RECEIVED_MESSAGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBasicAuth

SyntheticsBasicAuth: SyntheticsBasicAuthNTLM | SyntheticsBasicAuthSigv4 | SyntheticsBasicAuthWeb | UnparsedObject
+

SyntheticsBasicAuth

SyntheticsBasicAuth: SyntheticsBasicAuthNTLM | SyntheticsBasicAuthSigv4 | SyntheticsBasicAuthWeb | UnparsedObject

Object to handle basic authentication when performing the test.

-

SyntheticsBasicAuthNTLMType

SyntheticsBasicAuthNTLMType: typeof NTLM
+

SyntheticsBasicAuthNTLMType

SyntheticsBasicAuthNTLMType: typeof NTLM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBasicAuthSigv4Type

SyntheticsBasicAuthSigv4Type: typeof SIGV4
+

SyntheticsBasicAuthSigv4Type

SyntheticsBasicAuthSigv4Type: typeof SIGV4

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBasicAuthWebType

SyntheticsBasicAuthWebType: typeof WEB
+

SyntheticsBasicAuthWebType

SyntheticsBasicAuthWebType: typeof WEB

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBrowserErrorType

SyntheticsBrowserErrorType: typeof NETWORK | typeof JS
+

SyntheticsBrowserErrorType

SyntheticsBrowserErrorType: typeof NETWORK | typeof JS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBrowserTestFailureCode

SyntheticsBrowserTestFailureCode: typeof API_REQUEST_FAILURE | typeof ASSERTION_FAILURE | typeof DOWNLOAD_FILE_TOO_LARGE | typeof ELEMENT_NOT_INTERACTABLE | typeof EMAIL_VARIABLE_NOT_DEFINED | typeof EVALUATE_JAVASCRIPT | typeof EVALUATE_JAVASCRIPT_CONTEXT | typeof EXTRACT_VARIABLE | typeof FORBIDDEN_URL | typeof FRAME_DETACHED | typeof INCONSISTENCIES | typeof INTERNAL_ERROR | typeof INVALID_TYPE_TEXT_DELAY | typeof INVALID_URL | typeof INVALID_VARIABLE_PATTERN | typeof INVISIBLE_ELEMENT | typeof LOCATE_ELEMENT | typeof NAVIGATE_TO_LINK | typeof OPEN_URL | typeof PRESS_KEY | typeof SERVER_CERTIFICATE | typeof SELECT_OPTION | typeof STEP_TIMEOUT | typeof SUB_TEST_NOT_PASSED | typeof TEST_TIMEOUT | typeof TOO_MANY_HTTP_REQUESTS | typeof UNAVAILABLE_BROWSER | typeof UNKNOWN | typeof UNSUPPORTED_AUTH_SCHEMA | typeof UPLOAD_FILES_ELEMENT_TYPE | typeof UPLOAD_FILES_DIALOG | typeof UPLOAD_FILES_DYNAMIC_ELEMENT | typeof UPLOAD_FILES_NAME
+

SyntheticsBrowserTestFailureCode

SyntheticsBrowserTestFailureCode: typeof API_REQUEST_FAILURE | typeof ASSERTION_FAILURE | typeof DOWNLOAD_FILE_TOO_LARGE | typeof ELEMENT_NOT_INTERACTABLE | typeof EMAIL_VARIABLE_NOT_DEFINED | typeof EVALUATE_JAVASCRIPT | typeof EVALUATE_JAVASCRIPT_CONTEXT | typeof EXTRACT_VARIABLE | typeof FORBIDDEN_URL | typeof FRAME_DETACHED | typeof INCONSISTENCIES | typeof INTERNAL_ERROR | typeof INVALID_TYPE_TEXT_DELAY | typeof INVALID_URL | typeof INVALID_VARIABLE_PATTERN | typeof INVISIBLE_ELEMENT | typeof LOCATE_ELEMENT | typeof NAVIGATE_TO_LINK | typeof OPEN_URL | typeof PRESS_KEY | typeof SERVER_CERTIFICATE | typeof SELECT_OPTION | typeof STEP_TIMEOUT | typeof SUB_TEST_NOT_PASSED | typeof TEST_TIMEOUT | typeof TOO_MANY_HTTP_REQUESTS | typeof UNAVAILABLE_BROWSER | typeof UNKNOWN | typeof UNSUPPORTED_AUTH_SCHEMA | typeof UPLOAD_FILES_ELEMENT_TYPE | typeof UPLOAD_FILES_DIALOG | typeof UPLOAD_FILES_DYNAMIC_ELEMENT | typeof UPLOAD_FILES_NAME

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBrowserTestType

SyntheticsBrowserTestType: typeof BROWSER
+

SyntheticsBrowserTestType

SyntheticsBrowserTestType: typeof BROWSER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsBrowserVariableType

SyntheticsBrowserVariableType: typeof ELEMENT | typeof EMAIL | typeof GLOBAL | typeof JAVASCRIPT | typeof TEXT
+

SyntheticsBrowserVariableType

SyntheticsBrowserVariableType: typeof ELEMENT | typeof EMAIL | typeof GLOBAL | typeof JAVASCRIPT | typeof TEXT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsCheckType

SyntheticsCheckType: typeof EQUALS | typeof NOT_EQUALS | typeof CONTAINS | typeof NOT_CONTAINS | typeof STARTS_WITH | typeof NOT_STARTS_WITH | typeof GREATER | typeof LOWER | typeof GREATER_EQUALS | typeof LOWER_EQUALS | typeof MATCH_REGEX | typeof BETWEEN | typeof IS_EMPTY | typeof NOT_IS_EMPTY
+

SyntheticsCheckType

SyntheticsCheckType: typeof EQUALS | typeof NOT_EQUALS | typeof CONTAINS | typeof NOT_CONTAINS | typeof STARTS_WITH | typeof NOT_STARTS_WITH | typeof GREATER | typeof LOWER | typeof GREATER_EQUALS | typeof LOWER_EQUALS | typeof MATCH_REGEX | typeof BETWEEN | typeof IS_EMPTY | typeof NOT_IS_EMPTY

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsConfigVariableType

SyntheticsConfigVariableType: typeof GLOBAL | typeof TEXT
+

SyntheticsConfigVariableType

SyntheticsConfigVariableType: typeof GLOBAL | typeof TEXT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsDeviceID

SyntheticsDeviceID: typeof LAPTOP_LARGE | typeof TABLET | typeof MOBILE_SMALL | typeof CHROME_LAPTOP_LARGE | typeof CHROME_TABLET | typeof CHROME_MOBILE_SMALL | typeof FIREFOX_LAPTOP_LARGE | typeof FIREFOX_TABLET | typeof FIREFOX_MOBILE_SMALL | typeof EDGE_LAPTOP_LARGE | typeof EDGE_TABLET | typeof EDGE_MOBILE_SMALL
+

SyntheticsDeviceID

SyntheticsDeviceID: typeof LAPTOP_LARGE | typeof TABLET | typeof MOBILE_SMALL | typeof CHROME_LAPTOP_LARGE | typeof CHROME_TABLET | typeof CHROME_MOBILE_SMALL | typeof FIREFOX_LAPTOP_LARGE | typeof FIREFOX_TABLET | typeof FIREFOX_MOBILE_SMALL | typeof EDGE_LAPTOP_LARGE | typeof EDGE_TABLET | typeof EDGE_MOBILE_SMALL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsGlobalVariableParseTestOptionsType

SyntheticsGlobalVariableParseTestOptionsType: typeof HTTP_BODY | typeof HTTP_HEADER
+

SyntheticsGlobalVariableParseTestOptionsType

SyntheticsGlobalVariableParseTestOptionsType: typeof HTTP_BODY | typeof HTTP_HEADER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsGlobalVariableParserType

SyntheticsGlobalVariableParserType: typeof RAW | typeof JSON_PATH | typeof REGEX | typeof X_PATH
+

SyntheticsGlobalVariableParserType

SyntheticsGlobalVariableParserType: typeof RAW | typeof JSON_PATH | typeof REGEX | typeof X_PATH

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsPlayingTab

SyntheticsPlayingTab: typeof MAIN_TAB | typeof NEW_TAB | typeof TAB_1 | typeof TAB_2 | typeof TAB_3
+

SyntheticsPlayingTab

SyntheticsPlayingTab: typeof MAIN_TAB | typeof NEW_TAB | typeof TAB_1 | typeof TAB_2 | typeof TAB_3

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsStatus

SyntheticsStatus: typeof PASSED | typeof skipped | typeof failed
+

SyntheticsStatus

SyntheticsStatus: typeof PASSED | typeof skipped | typeof failed

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsStepType

SyntheticsStepType: typeof ASSERT_CURRENT_URL | typeof ASSERT_ELEMENT_ATTRIBUTE | typeof ASSERT_ELEMENT_CONTENT | typeof ASSERT_ELEMENT_PRESENT | typeof ASSERT_EMAIL | typeof ASSERT_FILE_DOWNLOAD | typeof ASSERT_FROM_JAVASCRIPT | typeof ASSERT_PAGE_CONTAINS | typeof ASSERT_PAGE_LACKS | typeof CLICK | typeof EXTRACT_FROM_JAVASCRIPT | typeof EXTRACT_VARIABLE | typeof GO_TO_EMAIL_LINK | typeof GO_TO_URL | typeof GO_TO_URL_AND_MEASURE_TTI | typeof HOVER | typeof PLAY_SUB_TEST | typeof PRESS_KEY | typeof REFRESH | typeof RUN_API_TEST | typeof SCROLL | typeof SELECT_OPTION | typeof TYPE_TEXT | typeof UPLOAD_FILES | typeof WAIT
+

SyntheticsStepType

SyntheticsStepType: typeof ASSERT_CURRENT_URL | typeof ASSERT_ELEMENT_ATTRIBUTE | typeof ASSERT_ELEMENT_CONTENT | typeof ASSERT_ELEMENT_PRESENT | typeof ASSERT_EMAIL | typeof ASSERT_FILE_DOWNLOAD | typeof ASSERT_FROM_JAVASCRIPT | typeof ASSERT_PAGE_CONTAINS | typeof ASSERT_PAGE_LACKS | typeof CLICK | typeof EXTRACT_FROM_JAVASCRIPT | typeof EXTRACT_VARIABLE | typeof GO_TO_EMAIL_LINK | typeof GO_TO_URL | typeof GO_TO_URL_AND_MEASURE_TTI | typeof HOVER | typeof PLAY_SUB_TEST | typeof PRESS_KEY | typeof REFRESH | typeof RUN_API_TEST | typeof SCROLL | typeof SELECT_OPTION | typeof TYPE_TEXT | typeof UPLOAD_FILES | typeof WAIT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsTestDetailsSubType

SyntheticsTestDetailsSubType: typeof HTTP | typeof SSL | typeof TCP | typeof DNS | typeof MULTI | typeof ICMP | typeof UDP | typeof WEBSOCKET
+

SyntheticsTestDetailsSubType

SyntheticsTestDetailsSubType: typeof HTTP | typeof SSL | typeof TCP | typeof DNS | typeof MULTI | typeof ICMP | typeof UDP | typeof WEBSOCKET

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsTestDetailsType

SyntheticsTestDetailsType: typeof API | typeof BROWSER
+

SyntheticsTestDetailsType

SyntheticsTestDetailsType: typeof API | typeof BROWSER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsTestExecutionRule

SyntheticsTestExecutionRule: typeof BLOCKING | typeof NON_BLOCKING | typeof SKIPPED
+

SyntheticsTestExecutionRule

SyntheticsTestExecutionRule: typeof BLOCKING | typeof NON_BLOCKING | typeof SKIPPED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsTestMonitorStatus

SyntheticsTestMonitorStatus: typeof UNTRIGGERED | typeof TRIGGERED | typeof NO_DATA
+

SyntheticsTestMonitorStatus

SyntheticsTestMonitorStatus: typeof UNTRIGGERED | typeof TRIGGERED | typeof NO_DATA

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsTestPauseStatus

SyntheticsTestPauseStatus: typeof LIVE | typeof PAUSED
+

SyntheticsTestPauseStatus

SyntheticsTestPauseStatus: typeof LIVE | typeof PAUSED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsTestProcessStatus

SyntheticsTestProcessStatus: typeof NOT_SCHEDULED | typeof SCHEDULED | typeof STARTED | typeof FINISHED | typeof FINISHED_WITH_ERROR
+

SyntheticsTestProcessStatus

SyntheticsTestProcessStatus: typeof NOT_SCHEDULED | typeof SCHEDULED | typeof STARTED | typeof FINISHED | typeof FINISHED_WITH_ERROR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

SyntheticsWarningType

SyntheticsWarningType: typeof USER_LOCATOR
+

SyntheticsWarningType

SyntheticsWarningType: typeof USER_LOCATOR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TableWidgetCellDisplayMode

TableWidgetCellDisplayMode: typeof NUMBER | typeof BAR
+

TableWidgetCellDisplayMode

TableWidgetCellDisplayMode: typeof NUMBER | typeof BAR

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TableWidgetDefinitionType

TableWidgetDefinitionType: typeof QUERY_TABLE
+

TableWidgetDefinitionType

TableWidgetDefinitionType: typeof QUERY_TABLE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TableWidgetHasSearchBar

TableWidgetHasSearchBar: typeof ALWAYS | typeof NEVER | typeof AUTO
+

TableWidgetHasSearchBar

TableWidgetHasSearchBar: typeof ALWAYS | typeof NEVER | typeof AUTO

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TargetFormatType

TargetFormatType: typeof AUTO | typeof STRING | typeof INTEGER | typeof DOUBLE
+

TargetFormatType

TargetFormatType: typeof AUTO | typeof STRING | typeof INTEGER | typeof DOUBLE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TimeseriesWidgetDefinitionType

TimeseriesWidgetDefinitionType: typeof TIMESERIES
+

TimeseriesWidgetDefinitionType

TimeseriesWidgetDefinitionType: typeof TIMESERIES

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TimeseriesWidgetLegendColumn

TimeseriesWidgetLegendColumn: typeof VALUE | typeof AVG | typeof SUM | typeof MIN | typeof MAX
+

TimeseriesWidgetLegendColumn

TimeseriesWidgetLegendColumn: typeof VALUE | typeof AVG | typeof SUM | typeof MIN | typeof MAX

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TimeseriesWidgetLegendLayout

TimeseriesWidgetLegendLayout: typeof AUTO | typeof HORIZONTAL | typeof VERTICAL
+

TimeseriesWidgetLegendLayout

TimeseriesWidgetLegendLayout: typeof AUTO | typeof HORIZONTAL | typeof VERTICAL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

ToplistWidgetDefinitionType

ToplistWidgetDefinitionType: typeof TOPLIST
+

ToplistWidgetDefinitionType

ToplistWidgetDefinitionType: typeof TOPLIST

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TreeMapColorBy

TreeMapColorBy: typeof USER
+

TreeMapColorBy

TreeMapColorBy: typeof USER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TreeMapGroupBy

TreeMapGroupBy: typeof USER | typeof FAMILY | typeof PROCESS
+

TreeMapGroupBy

TreeMapGroupBy: typeof USER | typeof FAMILY | typeof PROCESS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TreeMapSizeBy

TreeMapSizeBy: typeof PCT_CPU | typeof PCT_MEM
+

TreeMapSizeBy

TreeMapSizeBy: typeof PCT_CPU | typeof PCT_MEM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

TreeMapWidgetDefinitionType

TreeMapWidgetDefinitionType: typeof TREEMAP
+

TreeMapWidgetDefinitionType

TreeMapWidgetDefinitionType: typeof TREEMAP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

UsageAttributionSort

UsageAttributionSort: typeof API_PERCENTAGE | typeof SNMP_USAGE | typeof APM_HOST_USAGE | typeof API_USAGE | typeof CONTAINER_USAGE | typeof CUSTOM_TIMESERIES_PERCENTAGE | typeof CONTAINER_PERCENTAGE | typeof APM_HOST_PERCENTAGE | typeof NPM_HOST_PERCENTAGE | typeof BROWSER_PERCENTAGE | typeof BROWSER_USAGE | typeof INFRA_HOST_PERCENTAGE | typeof SNMP_PERCENTAGE | typeof NPM_HOST_USAGE | typeof INFRA_HOST_USAGE | typeof CUSTOM_TIMESERIES_USAGE | typeof LAMBDA_FUNCTIONS_USAGE | typeof LAMBDA_FUNCTIONS_PERCENTAGE | typeof LAMBDA_INVOCATIONS_USAGE | typeof LAMBDA_INVOCATIONS_PERCENTAGE | typeof LAMBDA_USAGE | typeof LAMBDA_PERCENTAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof ESTIMATED_INDEXED_LOGS_PERCENTAGE
+

UsageAttributionSort

UsageAttributionSort: typeof API_PERCENTAGE | typeof SNMP_USAGE | typeof APM_HOST_USAGE | typeof API_USAGE | typeof CONTAINER_USAGE | typeof CUSTOM_TIMESERIES_PERCENTAGE | typeof CONTAINER_PERCENTAGE | typeof APM_HOST_PERCENTAGE | typeof NPM_HOST_PERCENTAGE | typeof BROWSER_PERCENTAGE | typeof BROWSER_USAGE | typeof INFRA_HOST_PERCENTAGE | typeof SNMP_PERCENTAGE | typeof NPM_HOST_USAGE | typeof INFRA_HOST_USAGE | typeof CUSTOM_TIMESERIES_USAGE | typeof LAMBDA_FUNCTIONS_USAGE | typeof LAMBDA_FUNCTIONS_PERCENTAGE | typeof LAMBDA_INVOCATIONS_USAGE | typeof LAMBDA_INVOCATIONS_PERCENTAGE | typeof LAMBDA_USAGE | typeof LAMBDA_PERCENTAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof ESTIMATED_INDEXED_LOGS_PERCENTAGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

UsageAttributionSupportedMetrics

UsageAttributionSupportedMetrics: typeof CUSTOM_TIMESERIES_USAGE | typeof CONTAINER_USAGE | typeof SNMP_PERCENTAGE | typeof APM_HOST_USAGE | typeof BROWSER_USAGE | typeof NPM_HOST_PERCENTAGE | typeof INFRA_HOST_USAGE | typeof CUSTOM_TIMESERIES_PERCENTAGE | typeof CONTAINER_PERCENTAGE | typeof LAMBDA_USAGE | typeof API_USAGE | typeof APM_HOST_PERCENTAGE | typeof INFRA_HOST_PERCENTAGE | typeof SNMP_USAGE | typeof BROWSER_PERCENTAGE | typeof API_PERCENTAGE | typeof LAMBDA_PERCENTAGE | typeof NPM_HOST_USAGE | typeof LAMBDA_FUNCTIONS_USAGE | typeof LAMBDA_FUNCTIONS_PERCENTAGE | typeof LAMBDA_INVOCATIONS_USAGE | typeof LAMBDA_INVOCATIONS_PERCENTAGE | typeof FARGATE_USAGE | typeof FARGATE_PERCENTAGE | typeof PROFILED_HOST_USAGE | typeof PROFILED_HOST_PERCENTAGE | typeof PROFILED_CONTAINER_USAGE | typeof PROFILED_CONTAINER_PERCENTAGE | typeof DBM_HOSTS_USAGE | typeof DBM_HOSTS_PERCENTAGE | typeof DBM_QUERIES_USAGE | typeof DBM_QUERIES_PERCENTAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof ESTIMATED_INDEXED_LOGS_PERCENTAGE | typeof ALL
+

UsageAttributionSupportedMetrics

UsageAttributionSupportedMetrics: typeof CUSTOM_TIMESERIES_USAGE | typeof CONTAINER_USAGE | typeof SNMP_PERCENTAGE | typeof APM_HOST_USAGE | typeof BROWSER_USAGE | typeof NPM_HOST_PERCENTAGE | typeof INFRA_HOST_USAGE | typeof CUSTOM_TIMESERIES_PERCENTAGE | typeof CONTAINER_PERCENTAGE | typeof LAMBDA_USAGE | typeof API_USAGE | typeof APM_HOST_PERCENTAGE | typeof INFRA_HOST_PERCENTAGE | typeof SNMP_USAGE | typeof BROWSER_PERCENTAGE | typeof API_PERCENTAGE | typeof LAMBDA_PERCENTAGE | typeof NPM_HOST_USAGE | typeof LAMBDA_FUNCTIONS_USAGE | typeof LAMBDA_FUNCTIONS_PERCENTAGE | typeof LAMBDA_INVOCATIONS_USAGE | typeof LAMBDA_INVOCATIONS_PERCENTAGE | typeof FARGATE_USAGE | typeof FARGATE_PERCENTAGE | typeof PROFILED_HOST_USAGE | typeof PROFILED_HOST_PERCENTAGE | typeof PROFILED_CONTAINER_USAGE | typeof PROFILED_CONTAINER_PERCENTAGE | typeof DBM_HOSTS_USAGE | typeof DBM_HOSTS_PERCENTAGE | typeof DBM_QUERIES_USAGE | typeof DBM_QUERIES_PERCENTAGE | typeof ESTIMATED_INDEXED_LOGS_USAGE | typeof ESTIMATED_INDEXED_LOGS_PERCENTAGE | typeof ALL

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

UsageMetricCategory

UsageMetricCategory: typeof STANDARD | typeof CUSTOM
+

UsageMetricCategory

UsageMetricCategory: typeof STANDARD | typeof CUSTOM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

UsageReportsType

UsageReportsType: typeof REPORTS
+

UsageReportsType

UsageReportsType: typeof REPORTS

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

UsageSort

UsageSort: typeof COMPUTED_ON | typeof SIZE | typeof START_DATE | typeof END_DATE
+

UsageSort

UsageSort: typeof COMPUTED_ON | typeof SIZE | typeof START_DATE | typeof END_DATE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

UsageSortDirection

UsageSortDirection: typeof DESC | typeof ASC
+

UsageSortDirection

UsageSortDirection: typeof DESC | typeof ASC

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WebhooksIntegrationEncoding

WebhooksIntegrationEncoding: typeof JSON | typeof FORM
+

WebhooksIntegrationEncoding

WebhooksIntegrationEncoding: typeof JSON | typeof FORM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetAggregator

WidgetAggregator: typeof AVERAGE | typeof LAST | typeof MAXIMUM | typeof MINIMUM | typeof SUM | typeof PERCENTILE
+

WidgetAggregator

WidgetAggregator: typeof AVERAGE | typeof LAST | typeof MAXIMUM | typeof MINIMUM | typeof SUM | typeof PERCENTILE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetChangeType

WidgetChangeType: typeof ABSOLUTE | typeof RELATIVE
+

WidgetChangeType

WidgetChangeType: typeof ABSOLUTE | typeof RELATIVE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetColorPreference

WidgetColorPreference: typeof BACKGROUND | typeof TEXT
+

WidgetColorPreference

WidgetColorPreference: typeof BACKGROUND | typeof TEXT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetComparator

WidgetComparator: typeof GREATER_THAN | typeof GREATER_THAN_OR_EQUAL_TO | typeof LESS_THAN | typeof LESS_THAN_OR_EQUAL_TO
+

WidgetComparator

WidgetComparator: typeof GREATER_THAN | typeof GREATER_THAN_OR_EQUAL_TO | typeof LESS_THAN | typeof LESS_THAN_OR_EQUAL_TO

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetCompareTo

WidgetCompareTo: typeof HOUR_BEFORE | typeof DAY_BEFORE | typeof WEEK_BEFORE | typeof MONTH_BEFORE
+

WidgetCompareTo

WidgetCompareTo: typeof HOUR_BEFORE | typeof DAY_BEFORE | typeof WEEK_BEFORE | typeof MONTH_BEFORE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetDefinition

WidgetDefinition: AlertGraphWidgetDefinition | AlertValueWidgetDefinition | ChangeWidgetDefinition | CheckStatusWidgetDefinition | DistributionWidgetDefinition | EventStreamWidgetDefinition | EventTimelineWidgetDefinition | FreeTextWidgetDefinition | FunnelWidgetDefinition | GeomapWidgetDefinition | GroupWidgetDefinition | HeatMapWidgetDefinition | HostMapWidgetDefinition | IFrameWidgetDefinition | ImageWidgetDefinition | ListStreamWidgetDefinition | LogStreamWidgetDefinition | MonitorSummaryWidgetDefinition | NoteWidgetDefinition | QueryValueWidgetDefinition | SLOWidgetDefinition | ScatterPlotWidgetDefinition | ServiceMapWidgetDefinition | ServiceSummaryWidgetDefinition | SunburstWidgetDefinition | TableWidgetDefinition | TimeseriesWidgetDefinition | ToplistWidgetDefinition | TreeMapWidgetDefinition | UnparsedObject
+

WidgetDefinition

WidgetDefinition: AlertGraphWidgetDefinition | AlertValueWidgetDefinition | ChangeWidgetDefinition | CheckStatusWidgetDefinition | DistributionWidgetDefinition | EventStreamWidgetDefinition | EventTimelineWidgetDefinition | FreeTextWidgetDefinition | FunnelWidgetDefinition | GeomapWidgetDefinition | GroupWidgetDefinition | HeatMapWidgetDefinition | HostMapWidgetDefinition | IFrameWidgetDefinition | ImageWidgetDefinition | ListStreamWidgetDefinition | LogStreamWidgetDefinition | MonitorSummaryWidgetDefinition | NoteWidgetDefinition | QueryValueWidgetDefinition | SLOWidgetDefinition | ScatterPlotWidgetDefinition | ServiceMapWidgetDefinition | ServiceSummaryWidgetDefinition | SunburstWidgetDefinition | TableWidgetDefinition | TimeseriesWidgetDefinition | ToplistWidgetDefinition | TreeMapWidgetDefinition | UnparsedObject

Definition of the widget.

-

WidgetDisplayType

WidgetDisplayType: typeof AREA | typeof BARS | typeof LINE
+

WidgetDisplayType

WidgetDisplayType: typeof AREA | typeof BARS | typeof LINE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetEventSize

WidgetEventSize: typeof SMALL | typeof LARGE
+

WidgetEventSize

WidgetEventSize: typeof SMALL | typeof LARGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetGrouping

WidgetGrouping: typeof CHECK | typeof CLUSTER
+

WidgetGrouping

WidgetGrouping: typeof CHECK | typeof CLUSTER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetHorizontalAlign

WidgetHorizontalAlign: typeof CENTER | typeof LEFT | typeof RIGHT
+

WidgetHorizontalAlign

WidgetHorizontalAlign: typeof CENTER | typeof LEFT | typeof RIGHT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetImageSizing

WidgetImageSizing: typeof FILL | typeof CONTAIN | typeof COVER | typeof NONE | typeof SCALEDOWN | typeof ZOOM | typeof FIT | typeof CENTER
+

WidgetImageSizing

WidgetImageSizing: typeof FILL | typeof CONTAIN | typeof COVER | typeof NONE | typeof SCALEDOWN | typeof ZOOM | typeof FIT | typeof CENTER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetLayoutType

WidgetLayoutType: typeof ORDERED
+

WidgetLayoutType

WidgetLayoutType: typeof ORDERED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetLineType

WidgetLineType: typeof DASHED | typeof DOTTED | typeof SOLID
+

WidgetLineType

WidgetLineType: typeof DASHED | typeof DOTTED | typeof SOLID

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetLineWidth

WidgetLineWidth: typeof NORMAL | typeof THICK | typeof THIN
+

WidgetLineWidth

WidgetLineWidth: typeof NORMAL | typeof THICK | typeof THIN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetLiveSpan

WidgetLiveSpan: typeof PAST_ONE_MINUTE | typeof PAST_FIVE_MINUTES | typeof PAST_TEN_MINUTES | typeof PAST_FIFTEEN_MINUTES | typeof PAST_THIRTY_MINUTES | typeof PAST_ONE_HOUR | typeof PAST_FOUR_HOURS | typeof PAST_ONE_DAY | typeof PAST_TWO_DAYS | typeof PAST_ONE_WEEK | typeof PAST_ONE_MONTH | typeof PAST_THREE_MONTHS | typeof PAST_SIX_MONTHS | typeof PAST_ONE_YEAR | typeof ALERT
+

WidgetLiveSpan

WidgetLiveSpan: typeof PAST_ONE_MINUTE | typeof PAST_FIVE_MINUTES | typeof PAST_TEN_MINUTES | typeof PAST_FIFTEEN_MINUTES | typeof PAST_THIRTY_MINUTES | typeof PAST_ONE_HOUR | typeof PAST_FOUR_HOURS | typeof PAST_ONE_DAY | typeof PAST_TWO_DAYS | typeof PAST_ONE_WEEK | typeof PAST_ONE_MONTH | typeof PAST_THREE_MONTHS | typeof PAST_SIX_MONTHS | typeof PAST_ONE_YEAR | typeof ALERT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetMargin

WidgetMargin: typeof SM | typeof MD | typeof LG | typeof SMALL | typeof LARGE
+

WidgetMargin

WidgetMargin: typeof SM | typeof MD | typeof LG | typeof SMALL | typeof LARGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetMessageDisplay

WidgetMessageDisplay: typeof INLINE | typeof EXPANDED_MEDIUM | typeof EXPANDED_LARGE
+

WidgetMessageDisplay

WidgetMessageDisplay: typeof INLINE | typeof EXPANDED_MEDIUM | typeof EXPANDED_LARGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetMonitorSummaryDisplayFormat

WidgetMonitorSummaryDisplayFormat: typeof COUNTS | typeof COUNTS_AND_LIST | typeof LIST
+

WidgetMonitorSummaryDisplayFormat

WidgetMonitorSummaryDisplayFormat: typeof COUNTS | typeof COUNTS_AND_LIST | typeof LIST

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetMonitorSummarySort

WidgetMonitorSummarySort: typeof NAME | typeof GROUP | typeof STATUS | typeof TAGS | typeof TRIGGERED | typeof GROUP_ASCENDING | typeof GROUP_DESCENDING | typeof NAME_ASCENDING | typeof NAME_DESCENDING | typeof STATUS_ASCENDING | typeof STATUS_DESCENDING | typeof TAGS_ASCENDING | typeof TAGS_DESCENDING | typeof TRIGGERED_ASCENDING | typeof TRIGGERED_DESCENDING
+

WidgetMonitorSummarySort

WidgetMonitorSummarySort: typeof NAME | typeof GROUP | typeof STATUS | typeof TAGS | typeof TRIGGERED | typeof GROUP_ASCENDING | typeof GROUP_DESCENDING | typeof NAME_ASCENDING | typeof NAME_DESCENDING | typeof STATUS_ASCENDING | typeof STATUS_DESCENDING | typeof TAGS_ASCENDING | typeof TAGS_DESCENDING | typeof TRIGGERED_ASCENDING | typeof TRIGGERED_DESCENDING

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetNodeType

WidgetNodeType: typeof HOST | typeof CONTAINER
+

WidgetNodeType

WidgetNodeType: typeof HOST | typeof CONTAINER

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetOrderBy

WidgetOrderBy: typeof CHANGE | typeof NAME | typeof PRESENT | typeof PAST
+

WidgetOrderBy

WidgetOrderBy: typeof CHANGE | typeof NAME | typeof PRESENT | typeof PAST

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetPalette

WidgetPalette: typeof BLUE | typeof CUSTOM_BACKGROUND | typeof CUSTOM_IMAGE | typeof CUSTOM_TEXT | typeof GRAY_ON_WHITE | typeof GREY | typeof GREEN | typeof ORANGE | typeof RED | typeof RED_ON_WHITE | typeof WHITE_ON_GRAY | typeof WHITE_ON_GREEN | typeof GREEN_ON_WHITE | typeof WHITE_ON_RED | typeof WHITE_ON_YELLOW | typeof YELLOW_ON_WHITE | typeof BLACK_ON_LIGHT_YELLOW | typeof BLACK_ON_LIGHT_GREEN | typeof BLACK_ON_LIGHT_RED
+

WidgetPalette

WidgetPalette: typeof BLUE | typeof CUSTOM_BACKGROUND | typeof CUSTOM_IMAGE | typeof CUSTOM_TEXT | typeof GRAY_ON_WHITE | typeof GREY | typeof GREEN | typeof ORANGE | typeof RED | typeof RED_ON_WHITE | typeof WHITE_ON_GRAY | typeof WHITE_ON_GREEN | typeof GREEN_ON_WHITE | typeof WHITE_ON_RED | typeof WHITE_ON_YELLOW | typeof YELLOW_ON_WHITE | typeof BLACK_ON_LIGHT_YELLOW | typeof BLACK_ON_LIGHT_GREEN | typeof BLACK_ON_LIGHT_RED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetServiceSummaryDisplayFormat

WidgetServiceSummaryDisplayFormat: typeof ONE_COLUMN | typeof TWO_COLUMN | typeof THREE_COLUMN
+

WidgetServiceSummaryDisplayFormat

WidgetServiceSummaryDisplayFormat: typeof ONE_COLUMN | typeof TWO_COLUMN | typeof THREE_COLUMN

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetSizeFormat

WidgetSizeFormat: typeof SMALL | typeof MEDIUM | typeof LARGE
+

WidgetSizeFormat

WidgetSizeFormat: typeof SMALL | typeof MEDIUM | typeof LARGE

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetSort

WidgetSort: typeof ASCENDING | typeof DESCENDING
+

WidgetSort

WidgetSort: typeof ASCENDING | typeof DESCENDING

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetSummaryType

WidgetSummaryType: typeof MONITORS | typeof GROUPS | typeof COMBINED
+

WidgetSummaryType

WidgetSummaryType: typeof MONITORS | typeof GROUPS | typeof COMBINED

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetTextAlign

WidgetTextAlign: typeof CENTER | typeof LEFT | typeof RIGHT
+

WidgetTextAlign

WidgetTextAlign: typeof CENTER | typeof LEFT | typeof RIGHT

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetTickEdge

WidgetTickEdge: typeof BOTTOM | typeof LEFT | typeof RIGHT | typeof TOP
+

WidgetTickEdge

WidgetTickEdge: typeof BOTTOM | typeof LEFT | typeof RIGHT | typeof TOP

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetTimeWindows

WidgetTimeWindows: typeof SEVEN_DAYS | typeof THIRTY_DAYS | typeof NINETY_DAYS | typeof WEEK_TO_DATE | typeof PREVIOUS_WEEK | typeof MONTH_TO_DATE | typeof PREVIOUS_MONTH | typeof GLOBAL_TIME
+

WidgetTimeWindows

WidgetTimeWindows: typeof SEVEN_DAYS | typeof THIRTY_DAYS | typeof NINETY_DAYS | typeof WEEK_TO_DATE | typeof PREVIOUS_WEEK | typeof MONTH_TO_DATE | typeof PREVIOUS_MONTH | typeof GLOBAL_TIME

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetVerticalAlign

WidgetVerticalAlign: typeof CENTER | typeof TOP | typeof BOTTOM
+

WidgetVerticalAlign

WidgetVerticalAlign: typeof CENTER | typeof TOP | typeof BOTTOM

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetViewMode

WidgetViewMode: typeof OVERALL | typeof COMPONENT | typeof BOTH
+

WidgetViewMode

WidgetViewMode: typeof OVERALL | typeof COMPONENT | typeof BOTH

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

WidgetVizType

WidgetVizType: typeof TIMESERIES | typeof TOPLIST
+

WidgetVizType

WidgetVizType: typeof TIMESERIES | typeof TOPLIST

Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020-Present Datadog, Inc.

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

-

Variables

operationServers

operationServers: {} = ...

Type declaration

server1

server1: v1.ServerConfiguration<{ site: "datadoghq.com" | "us3.datadoghq.com" | "us5.datadoghq.com" | "datadoghq.eu" | "ddog-gov.com"; subdomain: string }> = ...

server2

server2: v1.ServerConfiguration<{ name: string; protocol: string }> = ...

server3

server3: v1.ServerConfiguration<{ site: string; subdomain: string }> = ...

servers

servers: v1.ServerConfiguration<{ site: "datadoghq.com" | "us3.datadoghq.com" | "us5.datadoghq.com" | "datadoghq.eu" | "ddog-gov.com"; subdomain: string }>[] = ...

Functions

configureAuthMethods

Variables

operationServers

operationServers: {} = ...

Type declaration

server1

server1: v1.ServerConfiguration<{ site: "datadoghq.com" | "us3.datadoghq.com" | "us5.datadoghq.com" | "datadoghq.eu" | "ddog-gov.com"; subdomain: string }> = ...

server2

server2: v1.ServerConfiguration<{ name: string; protocol: string }> = ...

server3

server3: v1.ServerConfiguration<{ site: string; subdomain: string }> = ...

servers

servers: v1.ServerConfiguration<{ site: "datadoghq.com" | "us3.datadoghq.com" | "us5.datadoghq.com" | "datadoghq.eu" | "ddog-gov.com"; subdomain: string }>[] = ...

Functions

configureAuthMethods

createConfiguration

createConfiguration

setServerVariables

Returns v1.Configuration

setServerVariables

setServerVariables