diff --git a/classes/client.ApiException.html b/classes/client.ApiException.html index aa56c2df6b0..e73171dcb71 100644 --- a/classes/client.ApiException.html +++ b/classes/client.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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: T

code

code: number

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

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

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: T

code

code: number

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

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

getName

  • getName(): string

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/client.AppKeyAuthAuthentication.html b/classes/client.AppKeyAuthAuthentication.html index 1dd191f66a7..06acdd99db0 100644 --- a/classes/client.AppKeyAuthAuthentication.html +++ b/classes/client.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

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/client.AuthZAuthentication.html b/classes/client.AuthZAuthentication.html index 9e51fb139b2..be92db934b9 100644 --- a/classes/client.AuthZAuthentication.html +++ b/classes/client.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

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

getName

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/client.BaseServerConfiguration.html b/classes/client.BaseServerConfiguration.html index 8b22d411dc9..76b6562f00b 100644 --- a/classes/client.BaseServerConfiguration.html +++ b/classes/client.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 RequestContext

setVariables

  • setVariables(variableConfiguration: {}): void

deleteAWSAccount

deleteAWSTagFilter

Returns Promise<any>

deleteAWSTagFilter

listAWSAccounts

Returns Promise<any>

listAWSAccounts

listAWSTagFilters

Returns Promise<AWSAccountListResponse>

listAWSTagFilters

listAvailableAWSNamespaces

  • listAvailableAWSNamespaces(options?: Configuration): Promise<string[]>

Returns Promise<AWSTagFilterListResponse>

listAvailableAWSNamespaces

  • listAvailableAWSNamespaces(options?: Configuration): Promise<string[]>

updateAWSAccount

updateAWSAccount

checkAWSLogsServicesAsync

Parameters

Returns Promise<AWSLogsAsyncResponse>

createAWSLambdaARN

Returns Promise<AWSLogsAsyncResponse>

createAWSLambdaARN

deleteAWSLambdaARN

Returns Promise<any>

deleteAWSLambdaARN

enableAWSLogServices

Returns Promise<any>

enableAWSLogServices

listAWSLogsIntegrations

Returns Promise<any>

listAWSLogsIntegrations

listAWSLogsServices

listAWSLogsServices

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsLambda.html b/classes/v1.AWSLogsLambda.html index 2548a3d3bdf..d688e64b982 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsListResponse.html b/classes/v1.AWSLogsListResponse.html index 75aad064624..d9e4a2160dd 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsListServicesResponse.html b/classes/v1.AWSLogsListServicesResponse.html index 25832714cea..ba8eca6e176 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSLogsServicesRequest.html b/classes/v1.AWSLogsServicesRequest.html index 2c65b2b1f60..d8a272c10f1 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilter.html b/classes/v1.AWSTagFilter.html index 2e3f68e9fd4..7ef2989fb95 100644 --- a/classes/v1.AWSTagFilter.html +++ b/classes/v1.AWSTagFilter.html @@ -1,7 +1,7 @@ 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
+

Hierarchy

  • AWSTagFilter

Index

Constructors

Properties

Constructors

constructor

Properties

Optional namespace

namespace?: AWSNamespace

The namespace associated with the tag filter entry.

-

Optional tagFilterStr

tagFilterStr?: string
+

Optional tagFilterStr

tagFilterStr?: string

The tag filter string.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilterCreateRequest.html b/classes/v1.AWSTagFilterCreateRequest.html index b34dea294b2..f147abf330c 100644 --- a/classes/v1.AWSTagFilterCreateRequest.html +++ b/classes/v1.AWSTagFilterCreateRequest.html @@ -1,9 +1,9 @@ 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 namespace

namespace?: AWSNamespace

The namespace associated with the tag filter entry.

-

Optional tagFilterStr

tagFilterStr?: string
+

Optional tagFilterStr

tagFilterStr?: string

The tag filter string.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilterDeleteRequest.html b/classes/v1.AWSTagFilterDeleteRequest.html index 98d37dba9f7..880001c30e0 100644 --- a/classes/v1.AWSTagFilterDeleteRequest.html +++ b/classes/v1.AWSTagFilterDeleteRequest.html @@ -1,7 +1,7 @@ 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
+

Optional namespace

namespace?: AWSNamespace

The namespace associated with the tag filter entry.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AWSTagFilterListResponse.html b/classes/v1.AWSTagFilterListResponse.html index 3e659472b81..c0a6144f1d4 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.

Generated using TypeDoc

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

Class AddSignalToIncidentRequest

Attributes describing which incident to add the signal to.

-

Hierarchy

  • AddSignalToIncidentRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional addToSignalTimeline

addToSignalTimeline?: boolean
+

Hierarchy

  • AddSignalToIncidentRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional addToSignalTimeline

addToSignalTimeline?: boolean

Whether to post the signal on the incident timeline.

-

incidentId

incidentId: number
+

incidentId

incidentId: number

Public ID attribute of the incident to which the signal will be added.

-

Optional version

version?: number
+

Optional version

version?: number

Version of the updated signal. If server side version is higher, update will be rejected.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AlertGraphWidgetDefinition.html b/classes/v1.AlertGraphWidgetDefinition.html index 9a53e12c942..de59f0db0fa 100644 --- a/classes/v1.AlertGraphWidgetDefinition.html +++ b/classes/v1.AlertGraphWidgetDefinition.html @@ -1,17 +1,17 @@ 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 time

time?: WidgetTime

Time setting for the widget.

-

Optional title

title?: string
+

Optional title

title?: string

The title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign
+

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

-

Optional titleSize

titleSize?: string
+

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "alert_graph"
+

type

type: "alert_graph"

Type of the alert graph widget.

-

vizType

vizType: WidgetVizType
+

vizType

vizType: WidgetVizType

Whether to display the Alert Graph as a timeseries or a top list.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AlertValueWidgetDefinition.html b/classes/v1.AlertValueWidgetDefinition.html index bc68dc38bdf..cf848ff30ce 100644 --- a/classes/v1.AlertValueWidgetDefinition.html +++ b/classes/v1.AlertValueWidgetDefinition.html @@ -1,19 +1,19 @@ 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 textAlign

textAlign?: WidgetTextAlign

How to align the text on the widget.

-

Optional title

title?: string
+

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign
+

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

-

Optional titleSize

titleSize?: string
+

Optional titleSize

titleSize?: string

Size of value in the widget.

-

type

type: "alert_value"
+

type

type: "alert_value"

Type of the alert value widget.

-

Optional unit

unit?: string
+

Optional unit

unit?: string

Unit to display with the value.

Generated using TypeDoc

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

Class ApiKey

Datadog API key.

-

Hierarchy

  • ApiKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: string
+

Hierarchy

  • ApiKey

Index

Constructors

Properties

Constructors

constructor

Properties

Optional created

created?: string

Date of creation of the API key.

-

Optional createdBy

createdBy?: string
+

Optional createdBy

createdBy?: string

Datadog user handle that created the API key.

-

Optional key

key?: string
+

Optional key

key?: string

API key.

-

Optional name

name?: string
+

Optional name

name?: string

Name of your API key.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApiKeyListResponse.html b/classes/v1.ApiKeyListResponse.html index 625c7f739d8..4415c5bc306 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApiKeyResponse.html b/classes/v1.ApiKeyResponse.html index 6bae2a9918c..eee62351fc4 100644 --- a/classes/v1.ApiKeyResponse.html +++ b/classes/v1.ApiKeyResponse.html @@ -1,5 +1,5 @@ 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
+

Hierarchy

  • ApiKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apiKey

apiKey?: ApiKey

Datadog API key.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApmStatsQueryColumnType.html b/classes/v1.ApmStatsQueryColumnType.html index 7681a03f67d..7691ee6c439 100644 --- a/classes/v1.ApmStatsQueryColumnType.html +++ b/classes/v1.ApmStatsQueryColumnType.html @@ -1,11 +1,11 @@ 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
+

Optional cellDisplayMode

cellDisplayMode?: TableWidgetCellDisplayMode

Define a display mode for the table cell.

-

name

name: string
+

name

name: string

Column name.

-

Optional order

order?: WidgetSort
+

Optional order

order?: WidgetSort

Widget sorting methods.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApmStatsQueryDefinition.html b/classes/v1.ApmStatsQueryDefinition.html index e9ace46623b..1459b32478e 100644 --- a/classes/v1.ApmStatsQueryDefinition.html +++ b/classes/v1.ApmStatsQueryDefinition.html @@ -1,17 +1,17 @@ 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
+

rowType

rowType: ApmStatsQueryRowType

The level of detail for the request.

-

service

service: string
+

service

service: string

Service name.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApplicationKey.html b/classes/v1.ApplicationKey.html index 0d49c95d763..6fe49e23b85 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApplicationKeyListResponse.html b/classes/v1.ApplicationKeyListResponse.html index c265dad55b5..4b1be4695bc 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.ApplicationKeyResponse.html b/classes/v1.ApplicationKeyResponse.html index 73c81559413..b747d21c7a9 100644 --- a/classes/v1.ApplicationKeyResponse.html +++ b/classes/v1.ApplicationKeyResponse.html @@ -1,5 +1,5 @@ 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
+

Hierarchy

  • ApplicationKeyResponse

Index

Constructors

Properties

Constructors

constructor

Properties

Optional applicationKey

applicationKey?: ApplicationKey

An application key with its associated metadata.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.AuthenticationApi.html b/classes/v1.AuthenticationApi.html index ed5fa20f6af..5fa73a982d1 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: Configuration, requestFactory?: AuthenticationApiRequestFactory, responseProcessor?: AuthenticationApiResponseProcessor): AuthenticationApi

Properties

Private configuration

configuration: Configuration

Private requestFactory

requestFactory: AuthenticationApiRequestFactory

Private responseProcessor

responseProcessor: AuthenticationApiResponseProcessor

Methods

validate

listAzureIntegration

updateAzureHostFilters

updateAzureHostFilters

updateAzureIntegration

Returns Promise<any>

updateAzureIntegration

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

Hierarchy

  • DistributionWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional legendSize

legendSize?: string
+

Hierarchy

  • DistributionWidgetDefinition

Index

Constructors

Properties

Constructors

constructor

Properties

Optional legendSize

legendSize?: string

(Deprecated) The widget legend was replaced by a tooltip and sidebar.

-

Optional markers

markers?: WidgetMarker[]
+

Optional markers

markers?: WidgetMarker[]

List of markers.

-

requests

requests: [DistributionWidgetRequest]
+

requests

requests: [DistributionWidgetRequest]

Array of one request object to display in the widget.

See the dedicated Request JSON schema documentation to learn how to build the REQUEST_SCHEMA.

-

Optional showLegend

showLegend?: boolean
+

Optional showLegend

showLegend?: boolean

(Deprecated) The widget legend was replaced by a tooltip and sidebar.

-

Optional time

time?: WidgetTime
+

Optional time

time?: WidgetTime

Time setting for the widget.

-

Optional title

title?: string
+

Optional title

title?: string

Title of the widget.

-

Optional titleAlign

titleAlign?: WidgetTextAlign
+

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

-

Optional titleSize

titleSize?: string
+

Optional titleSize

titleSize?: string

Size of the title.

-

type

type: "distribution"
+

type

type: "distribution"

Type of the distribution widget.

-

Optional xaxis

xaxis?: DistributionWidgetXAxis
+

Optional xaxis

xaxis?: DistributionWidgetXAxis

X Axis controls for the distribution widget.

-

Optional yaxis

yaxis?: DistributionWidgetYAxis
+

Optional yaxis

yaxis?: DistributionWidgetYAxis

Y Axis controls for the distribution widget.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DistributionWidgetRequest.html b/classes/v1.DistributionWidgetRequest.html index b15003b5c8b..61fed39b7de 100644 --- a/classes/v1.DistributionWidgetRequest.html +++ b/classes/v1.DistributionWidgetRequest.html @@ -1,29 +1,29 @@ 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
+

Hierarchy

  • DistributionWidgetRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional apmQuery

apmQuery?: LogQueryDefinition

The log query.

-

Optional apmStatsQuery

apmStatsQuery?: ApmStatsQueryDefinition
+

Optional apmStatsQuery

apmStatsQuery?: ApmStatsQueryDefinition

The APM stats query for table and distributions widgets.

-

Optional eventQuery

eventQuery?: LogQueryDefinition
+

Optional eventQuery

eventQuery?: LogQueryDefinition

The log query.

-

Optional logQuery

logQuery?: LogQueryDefinition
+

Optional logQuery

logQuery?: LogQueryDefinition

The log query.

-

Optional networkQuery

networkQuery?: LogQueryDefinition
+

Optional networkQuery

networkQuery?: LogQueryDefinition

The log query.

-

Optional processQuery

processQuery?: ProcessQueryDefinition
+

Optional processQuery

processQuery?: ProcessQueryDefinition

The process query to use in the widget.

-

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition
+

Optional profileMetricsQuery

profileMetricsQuery?: LogQueryDefinition

The log query.

-

Optional q

q?: string
+

Optional q

q?: string

Widget query.

-

Optional query

query?: DistributionWidgetHistogramRequestQuery
+

Optional query

query?: DistributionWidgetHistogramRequestQuery

Query definition for Distribution Widget Histogram Request

-

Optional requestType

requestType?: "histogram"
+

Optional requestType

requestType?: "histogram"

Request type for the histogram request.

-

Optional rumQuery

rumQuery?: LogQueryDefinition
+

Optional rumQuery

rumQuery?: LogQueryDefinition

The log query.

-

Optional securityQuery

securityQuery?: LogQueryDefinition
+

Optional securityQuery

securityQuery?: LogQueryDefinition

The log query.

-

Optional style

style?: WidgetStyle
+

Optional style

style?: WidgetStyle

Widget style definition.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DistributionWidgetXAxis.html b/classes/v1.DistributionWidgetXAxis.html index b3b4ccdc8e0..c546c946f7b 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DistributionWidgetYAxis.html b/classes/v1.DistributionWidgetYAxis.html index 7e0cd3742f4..e79c311b9e4 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.Downtime.html b/classes/v1.Downtime.html index 1631b15ef70..f4942c8207c 100644 --- a/classes/v1.Downtime.html +++ b/classes/v1.Downtime.html @@ -3,52 +3,52 @@ 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

Index

Constructors

Properties

Constructors

constructor

Properties

Optional active

active?: boolean
+

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional active

active?: boolean

If a scheduled downtime currently exists.

-

Optional activeChild

activeChild?: DowntimeChild
+

Optional activeChild

activeChild?: DowntimeChild

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

-

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 muteFirstRecoveryNotification

muteFirstRecoveryNotification?: boolean
+

Optional muteFirstRecoveryNotification

muteFirstRecoveryNotification?: boolean

If the first recovery notification during a downtime should be muted.

-

Optional parentId

parentId?: number
+

Optional parentId

parentId?: number

ID of the parent Downtime.

-

Optional recurrence

recurrence?: DowntimeRecurrence
+

Optional recurrence

recurrence?: DowntimeRecurrence

An object defining the recurrence of the downtime.

-

Optional scope

scope?: string[]
+

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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DowntimeChild.html b/classes/v1.DowntimeChild.html index cfecf4e7076..b88f6f14349 100644 --- a/classes/v1.DowntimeChild.html +++ b/classes/v1.DowntimeChild.html @@ -1,49 +1,49 @@ 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 muteFirstRecoveryNotification

muteFirstRecoveryNotification?: boolean
+

Optional muteFirstRecoveryNotification

muteFirstRecoveryNotification?: boolean

If the first recovery notification during a downtime should be muted.

-

Optional parentId

parentId?: number
+

Optional parentId

parentId?: number

ID of the parent Downtime.

-

Optional recurrence

recurrence?: DowntimeRecurrence
+

Optional recurrence

recurrence?: DowntimeRecurrence

An object defining the recurrence of the downtime.

-

Optional scope

scope?: string[]
+

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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DowntimeRecurrence.html b/classes/v1.DowntimeRecurrence.html index 7906e58fdc9..6a38e7282fc 100644 --- a/classes/v1.DowntimeRecurrence.html +++ b/classes/v1.DowntimeRecurrence.html @@ -1,23 +1,23 @@ 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.DowntimesApi.html b/classes/v1.DowntimesApi.html index e72b5c65d1a..198bbfc85d0 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: Configuration, requestFactory?: DowntimesApiRequestFactory, responseProcessor?: DowntimesApiResponseProcessor): DowntimesApi

Properties

Private configuration

configuration: 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

listEvents

listGCPIntegration

updateGCPIntegration

updateGCPIntegration

muteHost

unmuteHost

Returns Promise<HostMuteResponse>

unmuteHost

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

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 targetFormat

targetFormat?: TargetFormatType

If the target_type of the remapper is attribute, try to cast the value to a new specific type. If the cast is not possible, the original type is kept. string, integer, or double are the possible types. If the target_type is tag, this parameter may not be specified.

-

Optional targetType

targetType?: string
+

Optional targetType

targetType?: string

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

-

type

type: "attribute-remapper"
+

type

type: "attribute-remapper"

Type of logs attribute remapper.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetention.html b/classes/v1.LogsByRetention.html index 46923075297..c61e5e84089 100644 --- a/classes/v1.LogsByRetention.html +++ b/classes/v1.LogsByRetention.html @@ -1,9 +1,9 @@ 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
+

Hierarchy

  • LogsByRetention

Index

Constructors

Properties

Constructors

constructor

Properties

Optional orgs

orgs?: LogsByRetentionOrgs

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

-

Optional usage

usage?: LogsRetentionAggSumUsage[]
+

Optional usage

usage?: LogsRetentionAggSumUsage[]

Aggregated index logs usage for each retention period with usage.

-

Optional usageByMonth

usageByMonth?: LogsByRetentionMonthlyUsage
+

Optional usageByMonth

usageByMonth?: LogsByRetentionMonthlyUsage

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

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetentionMonthlyUsage.html b/classes/v1.LogsByRetentionMonthlyUsage.html index 04706903f48..a33d8074db7 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?: Date
+

Hierarchy

  • LogsByRetentionMonthlyUsage

Index

Constructors

Properties

Constructors

constructor

Properties

Optional date

date?: Date

The month for the usage.

-

Optional usage

usage?: LogsRetentionSumUsage[]
+

Optional usage

usage?: LogsRetentionSumUsage[]

Indexed logs usage for each active retention for the month.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetentionOrgUsage.html b/classes/v1.LogsByRetentionOrgUsage.html index cdf1f89911b..7684e72e242 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsByRetentionOrgs.html b/classes/v1.LogsByRetentionOrgs.html index 40d550b91e6..16de8a32437 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.

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/v1.LogsCategoryProcessor.html b/classes/v1.LogsCategoryProcessor.html index ba2d0e229d9..62650b9057f 100644 --- a/classes/v1.LogsCategoryProcessor.html +++ b/classes/v1.LogsCategoryProcessor.html @@ -12,15 +12,15 @@
  • 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

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    categories

    categories: LogsCategoryProcessorCategory[]
    +

    Hierarchy

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    categories

    categories: LogsCategoryProcessorCategory[]

    Array of filters to match or not a log and their corresponding name to 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"
    +

    type

    type: "category-processor"

    Type of logs category processor.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsCategoryProcessorCategory.html b/classes/v1.LogsCategoryProcessorCategory.html index 2118efe95f8..6b2f7a776d1 100644 --- a/classes/v1.LogsCategoryProcessorCategory.html +++ b/classes/v1.LogsCategoryProcessorCategory.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • LogsCategoryProcessorCategory

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: LogsFilter

    Filter for logs.

    -

    Optional name

    name?: string
    +

    Optional name

    name?: string

    Value to assign to the target attribute.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsDateRemapper.html b/classes/v1.LogsDateRemapper.html index e2a429bfb48..c5e30eaf627 100644 --- a/classes/v1.LogsDateRemapper.html +++ b/classes/v1.LogsDateRemapper.html @@ -16,12 +16,12 @@ 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

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional isEnabled

    isEnabled?: boolean
    +

    Hierarchy

    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"
    +

    type

    type: "date-remapper"

    Type of logs date remapper.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsExclusion.html b/classes/v1.LogsExclusion.html index 68551846793..c176734181e 100644 --- a/classes/v1.LogsExclusion.html +++ b/classes/v1.LogsExclusion.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • LogsExclusion

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: LogsExclusionFilter

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

    -

    Optional isEnabled

    isEnabled?: boolean
    +

    Optional isEnabled

    isEnabled?: boolean

    Whether or not the exclusion filter is active.

    -

    name

    name: string
    +

    name

    name: string

    Name of the index exclusion filter.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsExclusionFilter.html b/classes/v1.LogsExclusionFilter.html index bf04e8b40ee..8fc2ef80e1f 100644 --- a/classes/v1.LogsExclusionFilter.html +++ b/classes/v1.LogsExclusionFilter.html @@ -1,9 +1,9 @@ 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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsFilter.html b/classes/v1.LogsFilter.html index 45d05073f65..26908cec760 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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsGeoIPParser.html b/classes/v1.LogsGeoIPParser.html index f81281e951a..4c9d71e0906 100644 --- a/classes/v1.LogsGeoIPParser.html +++ b/classes/v1.LogsGeoIPParser.html @@ -1,14 +1,14 @@ 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"
    +

    type

    type: "geo-ip-parser"

    Type of GeoIP parser.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsGrokParser.html b/classes/v1.LogsGrokParser.html index f70d52b535b..10827b8f441 100644 --- a/classes/v1.LogsGrokParser.html +++ b/classes/v1.LogsGrokParser.html @@ -1,16 +1,16 @@ 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
    +

    Hierarchy

    • LogsGrokParser

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    grok

    grok: LogsGrokParserRules

    Set of rules for the grok parser.

    -

    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.

    -

    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"
    +

    type

    type: "grok-parser"

    Type of logs grok parser.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsGrokParserRules.html b/classes/v1.LogsGrokParserRules.html index 472788a37fd..baf00c44c69 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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsIndex.html b/classes/v1.LogsIndex.html index 6b828e658d7..da7d93b9f07 100644 --- a/classes/v1.LogsIndex.html +++ b/classes/v1.LogsIndex.html @@ -1,19 +1,19 @@ 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
    +

    filter

    filter: LogsFilter

    Filter for logs.

    -

    Optional isRateLimited

    isRateLimited?: boolean
    +

    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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsIndexListResponse.html b/classes/v1.LogsIndexListResponse.html index fc9e36461fe..7ec080f5399 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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsIndexUpdateRequest.html b/classes/v1.LogsIndexUpdateRequest.html index d5213aec1da..63538dba3ea 100644 --- a/classes/v1.LogsIndexUpdateRequest.html +++ b/classes/v1.LogsIndexUpdateRequest.html @@ -1,18 +1,18 @@ 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
    +

    filter

    filter: LogsFilter

    Filter for logs.

    -

    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.

    Note: Changing the retention for an index adjusts the length of retention for all logs diff --git a/classes/v1.LogsIndexesApi.html b/classes/v1.LogsIndexesApi.html index 075c2678802..8bd8bcbf4b6 100644 --- a/classes/v1.LogsIndexesApi.html +++ b/classes/v1.LogsIndexesApi.html @@ -1,24 +1,24 @@ -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: Configuration, requestFactory?: LogsIndexesApiRequestFactory, responseProcessor?: LogsIndexesApiResponseProcessor): LogsIndexesApi

    Properties

    Private configuration

    configuration: 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

    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"
    +

    type

    type: "message-remapper"

    Type of logs 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 3d1f78ad297..ebf451e562d 100644 --- a/classes/v1.LogsPipeline.html +++ b/classes/v1.LogsPipeline.html @@ -3,18 +3,18 @@ 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
    +

    Hierarchy

    • LogsPipeline

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: LogsFilter

    Filter for logs.

    -

    Optional id

    id?: string
    +

    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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsPipelineProcessor.html b/classes/v1.LogsPipelineProcessor.html index 5e2b69ee14a..215f89c6803 100644 --- a/classes/v1.LogsPipelineProcessor.html +++ b/classes/v1.LogsPipelineProcessor.html @@ -3,14 +3,14 @@ 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

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: LogsFilter
    +

    Hierarchy

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: LogsFilter

    Filter for logs.

    -

    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.

    -

    Optional processors

    processors?: LogsProcessor[]
    +

    Optional processors

    processors?: LogsProcessor[]

    Ordered list of processors in this pipeline.

    -

    type

    type: "pipeline"
    +

    type

    type: "pipeline"

    Type of logs pipeline processor.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsPipelinesApi.html b/classes/v1.LogsPipelinesApi.html index fa2de64e950..da9dce6c7d5 100644 --- a/classes/v1.LogsPipelinesApi.html +++ b/classes/v1.LogsPipelinesApi.html @@ -1,30 +1,30 @@ -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: Configuration, requestFactory?: LogsPipelinesApiRequestFactory, responseProcessor?: LogsPipelinesApiResponseProcessor): LogsPipelinesApi

    Properties

    Private configuration

    configuration: 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

    Hierarchy

    • LogsServiceRemapper

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional isEnabled

    isEnabled?: boolean
    +

    Hierarchy

    • LogsServiceRemapper

    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: "service-remapper"
    +

    type

    type: "service-remapper"

    Type of logs service remapper.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsStatusRemapper.html b/classes/v1.LogsStatusRemapper.html index d5864ee10cf..d11e0bbc6bd 100644 --- a/classes/v1.LogsStatusRemapper.html +++ b/classes/v1.LogsStatusRemapper.html @@ -16,12 +16,12 @@

    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

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional isEnabled

    isEnabled?: boolean
    +

    Hierarchy

    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"
    +

    type

    type: "status-remapper"

    Type of logs status remapper.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsStringBuilderProcessor.html b/classes/v1.LogsStringBuilderProcessor.html index 4561354fb71..19ce6746261 100644 --- a/classes/v1.LogsStringBuilderProcessor.html +++ b/classes/v1.LogsStringBuilderProcessor.html @@ -11,17 +11,17 @@
  • If the target attribute already exists, it is overwritten by the result of the template.
  • Results of the template cannot exceed 256 characters.
    • -

    Hierarchy

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional isEnabled

    isEnabled?: boolean
    +

    Hierarchy

    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"
    +

    type

    type: "string-builder-processor"

    Type of logs string builder processor.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsTraceRemapper.html b/classes/v1.LogsTraceRemapper.html index 5e8c4051672..7c4a594848d 100644 --- a/classes/v1.LogsTraceRemapper.html +++ b/classes/v1.LogsTraceRemapper.html @@ -7,12 +7,12 @@

  • Use the Trace remapper processor to define a log attribute as its associated trace ID.

    • -

    Hierarchy

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional isEnabled

    isEnabled?: boolean
    +

    Hierarchy

    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"
    +

    type

    type: "trace-id-remapper"

    Type of logs trace remapper.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsURLParser.html b/classes/v1.LogsURLParser.html index 08401242b56..4480fdd4ee1 100644 --- a/classes/v1.LogsURLParser.html +++ b/classes/v1.LogsURLParser.html @@ -1,15 +1,15 @@ 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"
    +

    type

    type: "url-parser"

    Type of logs URL parser.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.LogsUserAgentParser.html b/classes/v1.LogsUserAgentParser.html index 9c14a1d6976..40b8d4e2710 100644 --- a/classes/v1.LogsUserAgentParser.html +++ b/classes/v1.LogsUserAgentParser.html @@ -1,16 +1,16 @@ 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"
    +

    type

    type: "user-agent-parser"

    Type of logs User-Agent parser.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.MetricMetadata.html b/classes/v1.MetricMetadata.html index 72567843ebf..1d90909be43 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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.MetricSearchResponse.html b/classes/v1.MetricSearchResponse.html index b7cb7c70cd1..0e3fa8ebc5a 100644 --- a/classes/v1.MetricSearchResponse.html +++ b/classes/v1.MetricSearchResponse.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • MetricSearchResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional results

    results?: MetricSearchResponseResults

    Search result.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.MetricSearchResponseResults.html b/classes/v1.MetricSearchResponseResults.html index 5323687cb3d..b58a15e7779 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.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.MetricsApi.html b/classes/v1.MetricsApi.html index cd1bf771be7..05adca8c50e 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: Configuration, requestFactory?: MetricsApiRequestFactory, responseProcessor?: MetricsApiResponseProcessor): v1.MetricsApi

    Properties

    Private configuration

    configuration: Configuration

    Private requestFactory

    requestFactory: MetricsApiRequestFactory

    Private responseProcessor

    responseProcessor: MetricsApiResponseProcessor

    Methods

    getMetricMetadata

    listActiveMetrics

    listMetrics

    Returns Promise<MetricsListResponse>

    listMetrics

    queryMetrics

    Returns Promise<MetricSearchResponse>

    queryMetrics

    submitDistributionPoints

    Returns Promise<MetricsQueryResponse>

    submitDistributionPoints

    submitMetrics

    Returns Promise<v1.IntakePayloadAccepted>

    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:

      @@ -32,7 +32,7 @@

    Parameters

    Returns Promise<v1.IntakePayloadAccepted>

    updateMetricMetadata

    Returns Promise<v1.IntakePayloadAccepted>

    updateMetricMetadata

    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

    validateExistingMonitor

    Returns Promise<Monitor>

    validateExistingMonitor

    validateMonitor

    Returns Promise<any>

    validateMonitor

    getNotebook

    listNotebooks

    Returns Promise<NotebookResponse>

    listNotebooks

    updateNotebook

    Returns Promise<NotebooksResponse>

    updateNotebook

    listOrgs

    updateOrg

    updateOrg

    uploadIdPForOrg

    Returns Promise<OrganizationResponse>

    uploadIdPForOrg

    getPagerDutyIntegrationService

    updatePagerDutyIntegrationService

    Returns Promise<PagerDutyServiceName>

    updatePagerDutyIntegrationService

    Hierarchy

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOBulkDeleteResponseData
    +

    Hierarchy

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOBulkDeleteResponseData

    An array of service level objective objects.

    -

    Optional errors

    errors?: SLOBulkDeleteError[]
    +

    Optional errors

    errors?: SLOBulkDeleteError[]

    Array of errors object returned.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.SLOBulkDeleteResponseData.html b/classes/v1.SLOBulkDeleteResponseData.html index b371dacf240..7f6b5d5e871 100644 --- a/classes/v1.SLOBulkDeleteResponseData.html +++ b/classes/v1.SLOBulkDeleteResponseData.html @@ -1,9 +1,9 @@ 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).

    diff --git a/classes/v1.SLOCorrection.html b/classes/v1.SLOCorrection.html index d25be491ae3..9a6230344b9 100644 --- a/classes/v1.SLOCorrection.html +++ b/classes/v1.SLOCorrection.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • SLOCorrection

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: SLOCorrectionResponseAttributes

    The attribute object associated with the SLO correction.

    -

    Optional id

    id?: string
    +

    Optional id

    id?: string

    The ID of the SLO correction.

    -

    Optional type

    type?: "correction"
    +

    Optional type

    type?: "correction"

    SLO correction resource type.

    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 6bc3c3c9ed1..7f275b603a2 100644 --- a/classes/v1.SLOCorrectionCreateData.html +++ b/classes/v1.SLOCorrectionCreateData.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • SLOCorrectionCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: SLOCorrectionCreateRequestAttributes

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

    -

    type

    type: "correction"
    +

    type

    type: "correction"

    SLO correction resource type.

    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 c3c3c31d9f7..05341ac3c81 100644 --- a/classes/v1.SLOCorrectionCreateRequest.html +++ b/classes/v1.SLOCorrectionCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • SLOCorrectionCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOCorrectionCreateData

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

    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 46b69f55aec..0e837fb1406 100644 --- a/classes/v1.SLOCorrectionCreateRequestAttributes.html +++ b/classes/v1.SLOCorrectionCreateRequestAttributes.html @@ -1,20 +1,20 @@ 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
    +

    Hierarchy

    • SLOCorrectionCreateRequestAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    category

    category: SLOCorrectionCategory

    Category the SLO correction belongs to.

    -

    Optional description

    description?: string
    +

    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 applies 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 d8b6d867845..6f6d1528067 100644 --- a/classes/v1.SLOCorrectionListResponse.html +++ b/classes/v1.SLOCorrectionListResponse.html @@ -1,7 +1,7 @@ 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
    +

    Optional meta

    meta?: v1.ResponseMetaAttributes

    Object describing meta attributes of response.

    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 cbee355924d..d90052a539e 100644 --- a/classes/v1.SLOCorrectionResponse.html +++ b/classes/v1.SLOCorrectionResponse.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • SLOCorrectionResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOCorrection

    The response object of a list of SLO corrections.

    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 df745239654..4212d09e2d7 100644 --- a/classes/v1.SLOCorrectionResponseAttributes.html +++ b/classes/v1.SLOCorrectionResponseAttributes.html @@ -1,28 +1,28 @@ 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
    +

    Hierarchy

    • SLOCorrectionResponseAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional category

    category?: SLOCorrectionCategory

    Category the SLO correction belongs to.

    -

    Optional createdAt

    createdAt?: number
    +

    Optional createdAt

    createdAt?: number

    The epoch timestamp of when the correction was created at.

    -

    Optional creator

    creator?: v1.Creator
    +

    Optional creator

    creator?: v1.Creator

    Object describing the creator of the shared element.

    -

    Optional description

    description?: string
    +

    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 modifier

    modifier?: SLOCorrectionResponseAttributesModifier

    Modifier of the object.

    -

    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 sloId

    sloId?: string
    +

    Optional sloId

    sloId?: string

    ID of the SLO that this correction applies 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 5cf4831f835..40c776011d7 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 01928a561ac..ff6e86d7c23 100644 --- a/classes/v1.SLOCorrectionUpdateData.html +++ b/classes/v1.SLOCorrectionUpdateData.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • SLOCorrectionUpdateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: SLOCorrectionUpdateRequestAttributes

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

    -

    Optional type

    type?: "correction"
    +

    Optional type

    type?: "correction"

    SLO correction resource type.

    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 076deecba58..60d35f06740 100644 --- a/classes/v1.SLOCorrectionUpdateRequest.html +++ b/classes/v1.SLOCorrectionUpdateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • SLOCorrectionUpdateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOCorrectionUpdateData

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

    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 15167bc354b..6350c8002c1 100644 --- a/classes/v1.SLOCorrectionUpdateRequestAttributes.html +++ b/classes/v1.SLOCorrectionUpdateRequestAttributes.html @@ -1,18 +1,18 @@ 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
    +

    Hierarchy

    • SLOCorrectionUpdateRequestAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional category

    category?: SLOCorrectionCategory

    Category the SLO correction belongs to.

    -

    Optional description

    description?: string
    +

    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 b2e79e26112..86fd688b61c 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 b2a541da5eb..3952d4c7465 100644 --- a/classes/v1.SLOHistoryMetrics.html +++ b/classes/v1.SLOHistoryMetrics.html @@ -1,22 +1,22 @@ 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
    +

    Hierarchy

    • SLOHistoryMetrics

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    denominator

    denominator: SLOHistoryMetricsSeries

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

    -

    interval

    interval: number
    +

    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
    +

    numerator

    numerator: SLOHistoryMetricsSeries

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

    -

    query

    query: string
    +

    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 0f10030d96a..26b2d6bb284 100644 --- a/classes/v1.SLOHistoryMetricsSeries.html +++ b/classes/v1.SLOHistoryMetricsSeries.html @@ -1,12 +1,12 @@ 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
    +

    Optional metadata

    metadata?: SLOHistoryMetricsSeriesMetadata

    Query metadata.

    -

    sum

    sum: number
    +

    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 967beaf2d81..ea9784a5fac 100644 --- a/classes/v1.SLOHistoryMetricsSeriesMetadata.html +++ b/classes/v1.SLOHistoryMetricsSeriesMetadata.html @@ -1,16 +1,16 @@ 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.

    diff --git a/classes/v1.SLOHistoryMetricsSeriesMetadataUnit.html b/classes/v1.SLOHistoryMetricsSeriesMetadataUnit.html index 86531b2daf8..28d64750c01 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 9070bd16dca..8dc32d1bf5c 100644 --- a/classes/v1.SLOHistoryMonitor.html +++ b/classes/v1.SLOHistoryMonitor.html @@ -1,29 +1,29 @@ 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, number][]
    +

    Optional history

    history?: [number, 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 c2a6a728495..35d9fe23a63 100644 --- a/classes/v1.SLOHistoryResponse.html +++ b/classes/v1.SLOHistoryResponse.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • SLOHistoryResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOHistoryResponseData

    An array of service level objective objects.

    -

    Optional errors

    errors?: SLOHistoryResponseError[]
    +

    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 1879f59b918..a7329329908 100644 --- a/classes/v1.SLOHistoryResponseData.html +++ b/classes/v1.SLOHistoryResponseData.html @@ -1,29 +1,29 @@ 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 overall

    overall?: 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.

    -

    Optional series

    series?: SLOHistoryMetrics
    +

    Optional series

    series?: SLOHistoryMetrics

    A metric based SLO history response.

    This is not included in responses for monitor based SLOs.

    -

    Optional thresholds

    thresholds?: {}
    +

    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 type

    type?: SLOType

    The type of the service level objective.

    -

    Optional typeId

    typeId?: SLOTypeNumeric
    +

    Optional typeId

    typeId?: SLOTypeNumeric

    A numeric representation of the type of the service level objective (0 for monitor, 1 for metric). Always included in service level objective responses. Ignored in create/update requests.

    diff --git a/classes/v1.SLOHistoryResponseError.html b/classes/v1.SLOHistoryResponseError.html index 06303d4ad1a..4e72b36a6d6 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 f06ebf4905f..bd0fbca988d 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 471242d4b6c..d26116dd2ec 100644 --- a/classes/v1.SLOHistorySLIData.html +++ b/classes/v1.SLOHistorySLIData.html @@ -1,29 +1,29 @@ 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, number][]
    +

    Optional history

    history?: [number, 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 99f101b29b1..acdd178a805 100644 --- a/classes/v1.SLOListResponse.html +++ b/classes/v1.SLOListResponse.html @@ -1,10 +1,10 @@ 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
    +

    Optional metadata

    metadata?: SLOListResponseMetadata

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

    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 214f1e55c73..8338d0bdaee 100644 --- a/classes/v1.SLOListResponseMetadata.html +++ b/classes/v1.SLOListResponseMetadata.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • SLOListResponseMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional page

    page?: SLOListResponseMetadataPage

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

    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 93e22c42ba7..0cc71fe5fc9 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 e22c2e52f2f..4bad3e3c35d 100644 --- a/classes/v1.SLOResponse.html +++ b/classes/v1.SLOResponse.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • SLOResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SLOResponseData

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

    -

    Optional errors

    errors?: string[]
    +

    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 f59926b0021..be7d3169df0 100644 --- a/classes/v1.SLOResponseData.html +++ b/classes/v1.SLOResponseData.html @@ -1,51 +1,51 @@ 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 creator

    creator?: v1.Creator

    Object describing the creator of the shared element.

    -

    Optional description

    description?: string
    +

    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 query

    query?: ServiceLevelObjectiveQuery

    A metric-based SLO. Required if type is metric. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.

    -

    Optional tags

    tags?: string[]
    +

    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
    +

    Optional type

    type?: SLOType

    The type of the service level objective.

    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 4ada47bcf0c..c173fa37ace 100644 --- a/classes/v1.SLOThreshold.html +++ b/classes/v1.SLOThreshold.html @@ -1,18 +1,18 @@ 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
    +

    timeframe

    timeframe: SLOTimeframe

    The SLO time window options.

    -

    Optional warning

    warning?: number
    +

    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. diff --git a/classes/v1.SLOWidgetDefinition.html b/classes/v1.SLOWidgetDefinition.html index c6ecb4dbc87..3199c25e824 100644 --- a/classes/v1.SLOWidgetDefinition.html +++ b/classes/v1.SLOWidgetDefinition.html @@ -1,23 +1,23 @@ 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 titleAlign

    titleAlign?: WidgetTextAlign

    How to align the text on the widget.

    -

    Optional titleSize

    titleSize?: string
    +

    Optional titleSize

    titleSize?: string

    Size of the title.

    -

    type

    type: "slo"
    +

    type

    type: "slo"

    Type of the SLO widget.

    -

    Optional viewMode

    viewMode?: WidgetViewMode
    +

    Optional viewMode

    viewMode?: WidgetViewMode

    Define how you want the SLO to be displayed.

    -

    viewType

    viewType: string
    +

    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 ca5e1e3cc16..9d0f7f191f3 100644 --- a/classes/v1.ScatterPlotRequest.html +++ b/classes/v1.ScatterPlotRequest.html @@ -1,23 +1,23 @@ 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
    +

    Hierarchy

    • ScatterPlotRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional aggregator

    aggregator?: ScatterplotWidgetAggregator

    Aggregator used for the request.

    -

    Optional apmQuery

    apmQuery?: LogQueryDefinition
    +

    Optional apmQuery

    apmQuery?: LogQueryDefinition

    The log query.

    -

    Optional eventQuery

    eventQuery?: LogQueryDefinition
    +

    Optional eventQuery

    eventQuery?: LogQueryDefinition

    The log query.

    -

    Optional logQuery

    logQuery?: LogQueryDefinition
    +

    Optional logQuery

    logQuery?: LogQueryDefinition

    The log query.

    -

    Optional networkQuery

    networkQuery?: LogQueryDefinition
    +

    Optional networkQuery

    networkQuery?: LogQueryDefinition

    The log query.

    -

    Optional processQuery

    processQuery?: ProcessQueryDefinition
    +

    Optional processQuery

    processQuery?: ProcessQueryDefinition

    The process query to use in the widget.

    -

    Optional profileMetricsQuery

    profileMetricsQuery?: LogQueryDefinition
    +

    Optional profileMetricsQuery

    profileMetricsQuery?: LogQueryDefinition

    The log query.

    -

    Optional q

    q?: string
    +

    Optional q

    q?: string

    Query definition.

    -

    Optional rumQuery

    rumQuery?: LogQueryDefinition
    +

    Optional rumQuery

    rumQuery?: LogQueryDefinition

    The log query.

    -

    Optional securityQuery

    securityQuery?: LogQueryDefinition
    +

    Optional securityQuery

    securityQuery?: LogQueryDefinition

    The log query.

    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 f194c732135..b1f754d65d3 100644 --- a/classes/v1.ScatterPlotWidgetDefinition.html +++ b/classes/v1.ScatterPlotWidgetDefinition.html @@ -1,23 +1,23 @@ 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
    +

    requests

    requests: ScatterPlotWidgetDefinitionRequests

    Widget definition.

    -

    Optional time

    time?: WidgetTime
    +

    Optional time

    time?: WidgetTime

    Time setting for the widget.

    -

    Optional title

    title?: string
    +

    Optional title

    title?: string

    Title of your widget.

    -

    Optional titleAlign

    titleAlign?: WidgetTextAlign
    +

    Optional titleAlign

    titleAlign?: WidgetTextAlign

    How to align the text on the widget.

    -

    Optional titleSize

    titleSize?: string
    +

    Optional titleSize

    titleSize?: string

    Size of the title.

    -

    type

    type: "scatterplot"
    +

    type

    type: "scatterplot"

    Type of the scatter plot widget.

    -

    Optional xaxis

    xaxis?: WidgetAxis
    +

    Optional xaxis

    xaxis?: WidgetAxis

    Axis controls for the widget.

    -

    Optional yaxis

    yaxis?: WidgetAxis
    +

    Optional yaxis

    yaxis?: WidgetAxis

    Axis controls for the widget.

    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 3e89534e42c..f3f036620e6 100644 --- a/classes/v1.ScatterPlotWidgetDefinitionRequests.html +++ b/classes/v1.ScatterPlotWidgetDefinitionRequests.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • ScatterPlotWidgetDefinitionRequests

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional table

    table?: ScatterplotTableRequest

    Scatterplot request containing formulas and functions.

    -

    Optional x

    x?: ScatterPlotRequest
    +

    Optional x

    x?: ScatterPlotRequest

    Updated scatter plot.

    -

    Optional y

    y?: ScatterPlotRequest
    +

    Optional y

    y?: ScatterPlotRequest

    Updated scatter plot.

    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 9cef6631a98..d00e1e4920f 100644 --- a/classes/v1.ScatterplotTableRequest.html +++ b/classes/v1.ScatterplotTableRequest.html @@ -1,9 +1,9 @@ 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.

    -

    Optional queries

    queries?: FormulaAndFunctionQueryDefinition[]
    +

    Optional queries

    queries?: FormulaAndFunctionQueryDefinition[]

    List of queries that can be returned directly or used in formulas.

    -

    Optional responseFormat

    responseFormat?: FormulaAndFunctionResponseFormat
    +

    Optional responseFormat

    responseFormat?: FormulaAndFunctionResponseFormat

    Timeseries or Scalar response.

    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 08071b81ec4..51f586edbc5 100644 --- a/classes/v1.ScatterplotWidgetFormula.html +++ b/classes/v1.ScatterplotWidgetFormula.html @@ -1,9 +1,9 @@ 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
    +

    dimension

    dimension: ScatterplotDimension

    Dimension of the Scatterplot.

    -

    formula

    formula: string
    +

    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.SearchSLOResponse.html b/classes/v1.SearchSLOResponse.html index d853b2d0773..9b1e431a214 100644 --- a/classes/v1.SearchSLOResponse.html +++ b/classes/v1.SearchSLOResponse.html @@ -1,9 +1,9 @@ SearchSLOResponse | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class SearchSLOResponse

    A search SLO response containing results from the search query.

    -

    Hierarchy

    • SearchSLOResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SearchSLOResponseData
    +

    Hierarchy

    • SearchSLOResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: SearchSLOResponseData

    Data from search SLO response.

    -

    Optional links

    links?: SearchSLOResponseLinks
    +

    Optional links

    links?: SearchSLOResponseLinks

    Pagination links.

    -

    Optional meta

    meta?: SearchSLOResponseMeta
    +

    Optional meta

    meta?: SearchSLOResponseMeta

    Searches metadata returned by the API.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseData

    Data from search SLO response.

    -

    Hierarchy

    • SearchSLOResponseData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: SearchSLOResponseDataAttributes
    +

    Hierarchy

    • SearchSLOResponseData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: SearchSLOResponseDataAttributes

    Attributes

    -

    Optional type

    type?: string
    +

    Optional type

    type?: string

    Type of service level objective result.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseDataAttributes

    Attributes

    -

    Hierarchy

    • SearchSLOResponseDataAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional facets

    facets?: SearchSLOResponseDataAttributesFacets
    +

    Hierarchy

    • SearchSLOResponseDataAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional facets

    facets?: SearchSLOResponseDataAttributesFacets

    Facets

    -

    Optional slo

    slo?: ServiceLevelObjective[]
    +

    Optional slo

    slo?: ServiceLevelObjective[]

    SLOs

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseDataAttributesFacets

    Facets

    -

    Hierarchy

    • SearchSLOResponseDataAttributesFacets

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional allTags

    allTags?: SearchSLOResponseDataAttributesFacetsObjectString[]
    +

    Hierarchy

    • SearchSLOResponseDataAttributesFacets

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional allTags

    allTags?: SearchSLOResponseDataAttributesFacetsObjectString[]

    All tags associated with an SLO.

    -

    Optional creatorName

    creatorName?: SearchSLOResponseDataAttributesFacetsObjectString[]
    +

    Optional creatorName

    creatorName?: SearchSLOResponseDataAttributesFacetsObjectString[]

    Creator of an SLO.

    -

    Optional envTags

    envTags?: SearchSLOResponseDataAttributesFacetsObjectString[]
    +

    Optional envTags

    envTags?: SearchSLOResponseDataAttributesFacetsObjectString[]

    Tags with the env tag key.

    -

    Optional serviceTags

    serviceTags?: SearchSLOResponseDataAttributesFacetsObjectString[]
    +

    Optional serviceTags

    serviceTags?: SearchSLOResponseDataAttributesFacetsObjectString[]

    Tags with the service tag key.

    -

    Optional sloType

    sloType?: SearchSLOResponseDataAttributesFacetsObjectInt[]
    +

    Optional sloType

    sloType?: SearchSLOResponseDataAttributesFacetsObjectInt[]

    Type of SLO.

    -

    Optional target

    target?: SearchSLOResponseDataAttributesFacetsObjectInt[]
    +

    Optional target

    target?: SearchSLOResponseDataAttributesFacetsObjectInt[]

    SLO Target

    -

    Optional teamTags

    teamTags?: SearchSLOResponseDataAttributesFacetsObjectString[]
    +

    Optional teamTags

    teamTags?: SearchSLOResponseDataAttributesFacetsObjectString[]

    Tags with the team tag key.

    -

    Optional timeframe

    timeframe?: SearchSLOResponseDataAttributesFacetsObjectString[]
    +

    Optional timeframe

    timeframe?: SearchSLOResponseDataAttributesFacetsObjectString[]

    Timeframes of SLOs.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseDataAttributesFacetsObjectInt

    Facet

    -

    Hierarchy

    • SearchSLOResponseDataAttributesFacetsObjectInt

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional count

    count?: number
    +

    Hierarchy

    • SearchSLOResponseDataAttributesFacetsObjectInt

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional count

    count?: number

    Count

    -

    Optional name

    name?: number
    +

    Optional name

    name?: number

    Facet

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseDataAttributesFacetsObjectString

    Facet

    -

    Hierarchy

    • SearchSLOResponseDataAttributesFacetsObjectString

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional count

    count?: number
    +

    Hierarchy

    • SearchSLOResponseDataAttributesFacetsObjectString

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional count

    count?: number

    Count

    -

    Optional name

    name?: string
    +

    Optional name

    name?: string

    Facet

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseLinks

    Pagination links.

    -

    Hierarchy

    • SearchSLOResponseLinks

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional first

    first?: string
    +

    Hierarchy

    • SearchSLOResponseLinks

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional first

    first?: string

    Link to last page.

    -

    Optional last

    last?: string
    +

    Optional last

    last?: string

    Link to first page.

    -

    Optional next

    next?: string
    +

    Optional next

    next?: string

    Link to the next page.

    -

    Optional prev

    prev?: string
    +

    Optional prev

    prev?: string

    Link to previous page.

    -

    Optional self

    self?: string
    +

    Optional self

    self?: string

    Link to current page.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseMeta

    Searches metadata returned by the API.

    -

    Hierarchy

    • SearchSLOResponseMeta

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional pagination

    pagination?: SearchSLOResponseMetaPage
    +

    Hierarchy

    • SearchSLOResponseMeta

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional pagination

    pagination?: SearchSLOResponseMetaPage

    Pagination metadata returned by the API.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class SearchSLOResponseMetaPage

    Pagination metadata returned by the API.

    -

    Hierarchy

    • SearchSLOResponseMetaPage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional firstNumber

    firstNumber?: number
    +

    Hierarchy

    • SearchSLOResponseMetaPage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional firstNumber

    firstNumber?: number

    The first number.

    -

    Optional lastNumber

    lastNumber?: number
    +

    Optional lastNumber

    lastNumber?: number

    The last number.

    -

    Optional nextNumber

    nextNumber?: number
    +

    Optional nextNumber

    nextNumber?: number

    The next number.

    -

    Optional number

    number?: number
    +

    Optional number

    number?: number

    The page number.

    -

    Optional prevNumber

    prevNumber?: number
    +

    Optional prevNumber

    prevNumber?: number

    The previous page number.

    -

    Optional size

    size?: number
    +

    Optional size

    size?: number

    The size of the response.

    -

    Optional total

    total?: number
    +

    Optional total

    total?: number

    The total number of SLOs in the response.

    -

    Optional type

    type?: string
    +

    Optional type

    type?: string

    Type of pagination.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v1.SecurityMonitoringApi.html b/classes/v1.SecurityMonitoringApi.html index 12a1c39b906..86bbf40f46d 100644 --- a/classes/v1.SecurityMonitoringApi.html +++ b/classes/v1.SecurityMonitoringApi.html @@ -1,12 +1,12 @@ -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: Configuration, requestFactory?: SecurityMonitoringApiRequestFactory, responseProcessor?: SecurityMonitoringApiResponseProcessor): v1.SecurityMonitoringApi

    Properties

    Private configuration

    configuration: Configuration

    Private requestFactory

    requestFactory: SecurityMonitoringApiRequestFactory

    Private responseProcessor

    responseProcessor: SecurityMonitoringApiResponseProcessor

    Methods

    addSecurityMonitoringSignalToIncident

    editSecurityMonitoringSignalAssignee

    editSecurityMonitoringSignalState

    Returns Promise<SuccessfulSignalUpdateResponse>

    editSecurityMonitoringSignalState

    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

    searchSLO

    Returns Promise<SLOListResponse>

    searchSLO

    updateSLO

    Returns Promise<SearchSLOResponse>

    updateSLO

    getSlackIntegrationChannels

    removeSlackIntegrationChannel

    Returns Promise<SlackIntegrationChannel[]>

    removeSlackIntegrationChannel

    updateSlackIntegrationChannel

    Returns Promise<void>

    updateSlackIntegrationChannel

    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

    listHostTags

    updateHostTags

    Returns Promise<TagToHosts>

    updateHostTags

    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

    getUsageCIApp

    Returns Promise<UsageBillableSummaryResponse>

    getUsageCIApp

    getUsageCWS

    Returns Promise<UsageCIVisibilityResponse>

    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

    getUsageOnlineArchive

    Returns Promise<UsageNetworkHostsResponse>

    getUsageOnlineArchive

    getUsageProfiling

    Returns Promise<UsageOnlineArchiveResponse>

    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

    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

    Hierarchy

    • Widget

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    definition

    definition: WidgetDefinition
    +

    Hierarchy

    • Widget

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    definition

    definition: WidgetDefinition

    Definition of the widget.

    -

    Optional id

    id?: number
    +

    Optional id

    id?: number

    ID of the widget.

    -

    Optional layout

    layout?: WidgetLayout
    +

    Optional layout

    layout?: WidgetLayout

    The layout for a widget on a free or new dashboard layout dashboard.

    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 ced6c330c87..4f957af98e3 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 16271bef45a..1a750bdb6bb 100644 --- a/classes/v1.WidgetConditionalFormat.html +++ b/classes/v1.WidgetConditionalFormat.html @@ -1,21 +1,21 @@ 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
    +

    Hierarchy

    • WidgetConditionalFormat

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    comparator

    comparator: WidgetComparator

    Comparator to apply.

    -

    Optional customBgColor

    customBgColor?: string
    +

    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
    +

    palette

    palette: WidgetPalette

    Color palette to apply.

    -

    Optional timeframe

    timeframe?: string
    +

    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 1023e1e6997..129e8d9e38b 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 332d12af69b..e9ec62f81a3 100644 --- a/classes/v1.WidgetEvent.html +++ b/classes/v1.WidgetEvent.html @@ -2,8 +2,8 @@

    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 1037172115a..5b3a124a037 100644 --- a/classes/v1.WidgetFieldSort.html +++ b/classes/v1.WidgetFieldSort.html @@ -1,7 +1,7 @@ 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
    +

    order

    order: WidgetSort

    Widget sorting methods.

    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 e72bd3c790c..1a8b72629ad 100644 --- a/classes/v1.WidgetFormula.html +++ b/classes/v1.WidgetFormula.html @@ -1,13 +1,13 @@ 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 cellDisplayMode

    cellDisplayMode?: TableWidgetCellDisplayMode

    Define a display mode for the table cell.

    -

    Optional conditionalFormats

    conditionalFormats?: WidgetConditionalFormat[]
    +

    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
    +

    Optional limit

    limit?: WidgetFormulaLimit

    Options for limiting results returned.

    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 b24c1db33d3..a18d41eaaf5 100644 --- a/classes/v1.WidgetFormulaLimit.html +++ b/classes/v1.WidgetFormulaLimit.html @@ -1,7 +1,7 @@ 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
    +

    Optional order

    order?: v1.QuerySortOrder

    Direction of sort.

    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 e1bf5b6b264..95c27e3bf16 100644 --- a/classes/v1.WidgetLayout.html +++ b/classes/v1.WidgetLayout.html @@ -1,14 +1,14 @@ 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 0fc7c31ca6f..5fdcf147ecb 100644 --- a/classes/v1.WidgetMarker.html +++ b/classes/v1.WidgetMarker.html @@ -1,16 +1,16 @@ 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 f5b66093113..231414013de 100644 --- a/classes/v1.WidgetRequestStyle.html +++ b/classes/v1.WidgetRequestStyle.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • WidgetRequestStyle

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional lineType

    lineType?: WidgetLineType

    Type of lines displayed.

    -

    Optional lineWidth

    lineWidth?: WidgetLineWidth
    +

    Optional lineWidth

    lineWidth?: WidgetLineWidth

    Width of line displayed.

    -

    Optional palette

    palette?: string
    +

    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 60b74b41f6a..8ce4fb69544 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 2892d1519a4..126df10f2e4 100644 --- a/classes/v1.WidgetTime.html +++ b/classes/v1.WidgetTime.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • WidgetTime

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional liveSpan

    liveSpan?: WidgetLiveSpan

    The available timeframes depend on the widget you are using.

    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 220e88ae31a..782ff58949e 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 7a3aedcb9d0..ded91524126 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 32ea36069ee..9963d20eb52 100644 --- a/classes/v2.APIKeyCreateData.html +++ b/classes/v2.APIKeyCreateData.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • APIKeyCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    attributes

    attributes: APIKeyCreateAttributes

    Attributes used to create an API Key.

    -

    type

    type: "api_keys"
    +

    type

    type: "api_keys"

    API Keys resource type.

    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 bf4b2e69ace..f330cfb3319 100644 --- a/classes/v2.APIKeyCreateRequest.html +++ b/classes/v2.APIKeyCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • APIKeyCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: APIKeyCreateData

    Object used to create an API key.

    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 dd001f8e7bc..5bbe64ede09 100644 --- a/classes/v2.APIKeyRelationships.html +++ b/classes/v2.APIKeyRelationships.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • APIKeyRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional createdBy

    createdBy?: RelationshipToUser

    Relationship to user.

    -

    Optional modifiedBy

    modifiedBy?: RelationshipToUser
    +

    Optional modifiedBy

    modifiedBy?: RelationshipToUser

    Relationship to user.

    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 34421dccf95..314a664230c 100644 --- a/classes/v2.APIKeyResponse.html +++ b/classes/v2.APIKeyResponse.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • APIKeyResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: FullAPIKey

    Datadog API key.

    -

    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.APIKeyUpdateAttributes.html b/classes/v2.APIKeyUpdateAttributes.html index 2e774f69ba3..f074e163b89 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 118a3768eeb..f7ad5b7b4b1 100644 --- a/classes/v2.APIKeyUpdateData.html +++ b/classes/v2.APIKeyUpdateData.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • APIKeyUpdateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    attributes

    attributes: APIKeyUpdateAttributes

    Attributes used to update an API Key.

    -

    id

    id: string
    +

    id

    id: string

    ID of the API key.

    -

    type

    type: "api_keys"
    +

    type

    type: "api_keys"

    API Keys resource type.

    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 691d8b91c5c..a095a015e90 100644 --- a/classes/v2.APIKeyUpdateRequest.html +++ b/classes/v2.APIKeyUpdateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • APIKeyUpdateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: APIKeyUpdateData

    Object used to update an API key.

    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 f9d9960944e..3c19a3861e4 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.ApplicationKeyCreateAttributes.html b/classes/v2.ApplicationKeyCreateAttributes.html index 109d2934ba9..41fe178aa35 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 3ac7d709abb..bde3b66d019 100644 --- a/classes/v2.ApplicationKeyCreateData.html +++ b/classes/v2.ApplicationKeyCreateData.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • ApplicationKeyCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    attributes

    attributes: ApplicationKeyCreateAttributes

    Attributes used to create an application Key.

    -

    type

    type: "application_keys"
    +

    type

    type: "application_keys"

    Application Keys resource type.

    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 30ac9730df6..3e32e9126a3 100644 --- a/classes/v2.ApplicationKeyCreateRequest.html +++ b/classes/v2.ApplicationKeyCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • ApplicationKeyCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: ApplicationKeyCreateData

    Object used to create an application key.

    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 c8c70e5a718..c966477f93b 100644 --- a/classes/v2.ApplicationKeyRelationships.html +++ b/classes/v2.ApplicationKeyRelationships.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • ApplicationKeyRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional ownedBy

    ownedBy?: RelationshipToUser

    Relationship to user.

    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 f013293fccd..fce39993830 100644 --- a/classes/v2.ApplicationKeyResponse.html +++ b/classes/v2.ApplicationKeyResponse.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • ApplicationKeyResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: FullApplicationKey

    Datadog application key.

    -

    Optional included

    included?: ApplicationKeyResponseIncludedItem[]
    +

    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 fff7e076b67..d2f1b700598 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 30387a59237..8b601b169a2 100644 --- a/classes/v2.ApplicationKeyUpdateData.html +++ b/classes/v2.ApplicationKeyUpdateData.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • ApplicationKeyUpdateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    attributes

    attributes: ApplicationKeyUpdateAttributes

    Attributes used to update an application Key.

    -

    id

    id: string
    +

    id

    id: string

    ID of the application key.

    -

    type

    type: "application_keys"
    +

    type

    type: "application_keys"

    Application Keys resource type.

    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 ad2acc79bc5..8778eec17f5 100644 --- a/classes/v2.ApplicationKeyUpdateRequest.html +++ b/classes/v2.ApplicationKeyUpdateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • ApplicationKeyUpdateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: ApplicationKeyUpdateData

    Object used to update an application key.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class AuditApi

    Hierarchy

    • AuditApi

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new AuditApi(configuration: Configuration, requestFactory?: AuditApiRequestFactory, responseProcessor?: AuditApiResponseProcessor): AuditApi

    Properties

    Private configuration

    configuration: Configuration

    Private requestFactory

    requestFactory: AuditApiRequestFactory

    Private responseProcessor

    responseProcessor: AuditApiResponseProcessor

    Methods

    listAuditLogs

    listAuditLogsWithPagination

    searchAuditLogs

    searchAuditLogs

    searchAuditLogsWithPagination

    Returns Promise<AuditLogsEventsResponse>

    searchAuditLogsWithPagination

    Legend

    • Constructor
    • Method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsEvent.html b/classes/v2.AuditLogsEvent.html index 075cf7a4b95..8cd6bfd931f 100644 --- a/classes/v2.AuditLogsEvent.html +++ b/classes/v2.AuditLogsEvent.html @@ -1,9 +1,9 @@ AuditLogsEvent | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsEvent

    Object description of an Audit Logs event after it is processed and stored by Datadog.

    -

    Hierarchy

    • AuditLogsEvent

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: AuditLogsEventAttributes
    +

    Hierarchy

    • AuditLogsEvent

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: AuditLogsEventAttributes

    JSON object containing all event attributes and their associated values.

    -

    Optional id

    id?: string
    +

    Optional id

    id?: string

    Unique ID of the event.

    -

    Optional type

    type?: "audit"
    +

    Optional type

    type?: "audit"

    Type of the event.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsEventAttributes.html b/classes/v2.AuditLogsEventAttributes.html index 8266c7f8da7..cddf0c7746d 100644 --- a/classes/v2.AuditLogsEventAttributes.html +++ b/classes/v2.AuditLogsEventAttributes.html @@ -1,13 +1,13 @@ AuditLogsEventAttributes | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsEventAttributes

    JSON object containing all event attributes and their associated values.

    -

    Hierarchy

    • AuditLogsEventAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: {}
    +

    Hierarchy

    • AuditLogsEventAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: {}

    JSON object of attributes from Audit Logs events.

    -

    Type declaration

    • [key: string]: any

    Optional service

    service?: string
    +

    Type declaration

    • [key: string]: any

    Optional service

    service?: string

    Name of the application or service generating Audit Logs events. This name is used to correlate Audit Logs to APM, so make sure you specify the same value when you use both products.

    -

    Optional tags

    tags?: string[]
    +

    Optional tags

    tags?: string[]

    Array of tags associated with your event.

    -

    Optional timestamp

    timestamp?: Date
    +

    Optional timestamp

    timestamp?: Date

    Timestamp of your event.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsEventsResponse.html b/classes/v2.AuditLogsEventsResponse.html index 26b0c9a0888..0331238fe08 100644 --- a/classes/v2.AuditLogsEventsResponse.html +++ b/classes/v2.AuditLogsEventsResponse.html @@ -1,9 +1,9 @@ AuditLogsEventsResponse | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsEventsResponse

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

    -

    Hierarchy

    • AuditLogsEventsResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: AuditLogsEvent[]
    +

    Hierarchy

    • AuditLogsEventsResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: AuditLogsEvent[]

    Array of events matching the request.

    -

    Optional links

    links?: AuditLogsResponseLinks
    +

    Optional links

    links?: AuditLogsResponseLinks

    Links attributes.

    -

    Optional meta

    meta?: AuditLogsResponseMetadata
    +

    Optional meta

    meta?: AuditLogsResponseMetadata

    The metadata associated with a request.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsQueryFilter.html b/classes/v2.AuditLogsQueryFilter.html index a8162ef68b4..28e61c7eebd 100644 --- a/classes/v2.AuditLogsQueryFilter.html +++ b/classes/v2.AuditLogsQueryFilter.html @@ -1,9 +1,9 @@ AuditLogsQueryFilter | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsQueryFilter

    Search and filter query settings.

    -

    Hierarchy

    • AuditLogsQueryFilter

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional from

    from?: string
    +

    Hierarchy

    • AuditLogsQueryFilter

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional from

    from?: string

    Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).

    -

    Optional query

    query?: string
    +

    Optional query

    query?: string

    Search query following the Audit Logs search syntax.

    -

    Optional to

    to?: string
    +

    Optional to

    to?: string

    Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsQueryOptions.html b/classes/v2.AuditLogsQueryOptions.html index d74cb1cb5c8..a31e30b5677 100644 --- a/classes/v2.AuditLogsQueryOptions.html +++ b/classes/v2.AuditLogsQueryOptions.html @@ -1,8 +1,8 @@ AuditLogsQueryOptions | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsQueryOptions

    Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.

    -

    Hierarchy

    • AuditLogsQueryOptions

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional timeOffset

    timeOffset?: number
    +

    Hierarchy

    • AuditLogsQueryOptions

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional timeOffset

    timeOffset?: number

    Time offset (in seconds) to apply to the query.

    -

    Optional timezone

    timezone?: string
    +

    Optional timezone

    timezone?: string

    Timezone code. Can be specified as an offset, for example: "UTC+03:00".

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsQueryPageOptions.html b/classes/v2.AuditLogsQueryPageOptions.html index 9546ca2cfcb..2965cae95a8 100644 --- a/classes/v2.AuditLogsQueryPageOptions.html +++ b/classes/v2.AuditLogsQueryPageOptions.html @@ -1,7 +1,7 @@ AuditLogsQueryPageOptions | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsQueryPageOptions

    Paging attributes for listing events.

    -

    Hierarchy

    • AuditLogsQueryPageOptions

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional cursor

    cursor?: string
    +

    Hierarchy

    • AuditLogsQueryPageOptions

    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 events in the response.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsResponseLinks.html b/classes/v2.AuditLogsResponseLinks.html index 420db749535..be38dfd2972 100644 --- a/classes/v2.AuditLogsResponseLinks.html +++ b/classes/v2.AuditLogsResponseLinks.html @@ -1,6 +1,6 @@ AuditLogsResponseLinks | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsResponseLinks

    Links attributes.

    -

    Hierarchy

    • AuditLogsResponseLinks

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional next

    next?: string
    +

    Hierarchy

    • AuditLogsResponseLinks

    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.AuditLogsResponseMetadata.html b/classes/v2.AuditLogsResponseMetadata.html index b7975a0c3c9..abef07dffa6 100644 --- a/classes/v2.AuditLogsResponseMetadata.html +++ b/classes/v2.AuditLogsResponseMetadata.html @@ -1,14 +1,14 @@ AuditLogsResponseMetadata | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsResponseMetadata

    The metadata associated with a request.

    -

    Hierarchy

    • AuditLogsResponseMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional elapsed

    elapsed?: number
    +

    Hierarchy

    • AuditLogsResponseMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional elapsed

    elapsed?: number

    Time elapsed in milliseconds.

    -

    Optional page

    page?: AuditLogsResponsePage
    +

    Optional page

    page?: AuditLogsResponsePage

    Paging attributes.

    -

    Optional requestId

    requestId?: string
    +

    Optional requestId

    requestId?: string

    The identifier of the request.

    -

    Optional status

    status?: AuditLogsResponseStatus
    +

    Optional status

    status?: AuditLogsResponseStatus

    The status of the response.

    -

    Optional warnings

    warnings?: AuditLogsWarning[]
    +

    Optional warnings

    warnings?: AuditLogsWarning[]

    A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

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

    Class AuditLogsResponsePage

    Paging attributes.

    -

    Hierarchy

    • AuditLogsResponsePage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional after

    after?: string
    +

    Hierarchy

    • AuditLogsResponsePage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional after

    after?: 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 page[cursor].

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsSearchEventsRequest.html b/classes/v2.AuditLogsSearchEventsRequest.html index fd8bfd1d28c..a081b9bd38a 100644 --- a/classes/v2.AuditLogsSearchEventsRequest.html +++ b/classes/v2.AuditLogsSearchEventsRequest.html @@ -1,12 +1,12 @@ AuditLogsSearchEventsRequest | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsSearchEventsRequest

    The request for a Audit Logs events list.

    -

    Hierarchy

    • AuditLogsSearchEventsRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: AuditLogsQueryFilter
    +

    Hierarchy

    • AuditLogsSearchEventsRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: AuditLogsQueryFilter

    Search and filter query settings.

    -

    Optional options

    options?: AuditLogsQueryOptions
    +

    Optional options

    options?: AuditLogsQueryOptions

    Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.

    -

    Optional page

    page?: AuditLogsQueryPageOptions
    +

    Optional page

    page?: AuditLogsQueryPageOptions

    Paging attributes for listing events.

    -

    Optional sort

    sort?: AuditLogsSort
    +

    Optional sort

    sort?: AuditLogsSort

    Sort parameters when querying events.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.AuditLogsWarning.html b/classes/v2.AuditLogsWarning.html index 14d9f87a1b9..c95678f3069 100644 --- a/classes/v2.AuditLogsWarning.html +++ b/classes/v2.AuditLogsWarning.html @@ -1,9 +1,9 @@ AuditLogsWarning | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class AuditLogsWarning

    Warning message indicating something that went wrong with the query.

    -

    Hierarchy

    • AuditLogsWarning

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional code

    code?: string
    +

    Hierarchy

    • AuditLogsWarning

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional code

    code?: string

    Unique code for this type of warning.

    -

    Optional detail

    detail?: string
    +

    Optional detail

    detail?: string

    Detailed explanation of this specific warning.

    -

    Optional title

    title?: string
    +

    Optional title

    title?: string

    Short human-readable summary of the warning.

    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 f7bb2406991..9722e313f96 100644 --- a/classes/v2.AuthNMapping.html +++ b/classes/v2.AuthNMapping.html @@ -1,11 +1,11 @@ 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
    +

    Hierarchy

    • AuthNMapping

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: AuthNMappingAttributes

    Attributes of AuthN Mapping.

    -

    id

    id: string
    +

    id

    id: string

    ID of the AuthN Mapping.

    -

    Optional relationships

    relationships?: AuthNMappingRelationships
    +

    Optional relationships

    relationships?: AuthNMappingRelationships

    All relationships associated with AuthN Mapping.

    -

    type

    type: "authn_mappings"
    +

    type

    type: "authn_mappings"

    AuthN Mappings resource type.

    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 cdda6de105e..ae21d981c1c 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?: string
    +

    Optional samlAssertionAttributeId

    samlAssertionAttributeId?: string

    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 90f63eda3c9..88c0d87b33a 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 ff1d3c4351f..b402a814394 100644 --- a/classes/v2.AuthNMappingCreateData.html +++ b/classes/v2.AuthNMappingCreateData.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • AuthNMappingCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: AuthNMappingCreateAttributes

    Key/Value pair of attributes used for create request.

    -

    Optional relationships

    relationships?: AuthNMappingCreateRelationships
    +

    Optional relationships

    relationships?: AuthNMappingCreateRelationships

    Relationship of AuthN Mapping create object to Role.

    -

    type

    type: "authn_mappings"
    +

    type

    type: "authn_mappings"

    AuthN Mappings resource type.

    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 65c9baaf662..5bdc0e045e8 100644 --- a/classes/v2.AuthNMappingCreateRelationships.html +++ b/classes/v2.AuthNMappingCreateRelationships.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • AuthNMappingCreateRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional role

    role?: RelationshipToRole

    Relationship to role.

    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 45396f63756..0bfab7e9639 100644 --- a/classes/v2.AuthNMappingCreateRequest.html +++ b/classes/v2.AuthNMappingCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • AuthNMappingCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: AuthNMappingCreateData

    Data for creating an AuthN Mapping.

    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 aac7b99d917..9c29f58bbc4 100644 --- a/classes/v2.AuthNMappingRelationships.html +++ b/classes/v2.AuthNMappingRelationships.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • AuthNMappingRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional role

    role?: RelationshipToRole

    Relationship to role.

    -

    Optional samlAssertionAttribute

    samlAssertionAttribute?: RelationshipToSAMLAssertionAttribute
    +

    Optional samlAssertionAttribute

    samlAssertionAttribute?: RelationshipToSAMLAssertionAttribute

    AuthN Mapping relationship to SAML Assertion Attribute.

    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 1c145daed2f..56e01554b9c 100644 --- a/classes/v2.AuthNMappingResponse.html +++ b/classes/v2.AuthNMappingResponse.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • AuthNMappingResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: AuthNMapping

    The AuthN Mapping object returned by API.

    -

    Optional included

    included?: AuthNMappingIncluded[]
    +

    Optional included

    included?: AuthNMappingIncluded[]

    Included data in the AuthN Mapping response.

    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 ad04d16ee04..8e0f4144ff1 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 20d449c7f62..242ab46e03d 100644 --- a/classes/v2.AuthNMappingUpdateData.html +++ b/classes/v2.AuthNMappingUpdateData.html @@ -1,11 +1,11 @@ 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
    +

    Hierarchy

    • AuthNMappingUpdateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: AuthNMappingUpdateAttributes

    Key/Value pair of attributes used for update request.

    -

    id

    id: string
    +

    id

    id: string

    ID of the AuthN Mapping.

    -

    Optional relationships

    relationships?: AuthNMappingUpdateRelationships
    +

    Optional relationships

    relationships?: AuthNMappingUpdateRelationships

    Relationship of AuthN Mapping update object to Role.

    -

    type

    type: "authn_mappings"
    +

    type

    type: "authn_mappings"

    AuthN Mappings resource type.

    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 648b65d3066..d0b8ad35db2 100644 --- a/classes/v2.AuthNMappingUpdateRelationships.html +++ b/classes/v2.AuthNMappingUpdateRelationships.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • AuthNMappingUpdateRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional role

    role?: RelationshipToRole

    Relationship to role.

    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 f6a8a7497d7..3268ee96ea1 100644 --- a/classes/v2.AuthNMappingUpdateRequest.html +++ b/classes/v2.AuthNMappingUpdateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • AuthNMappingUpdateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: AuthNMappingUpdateData

    Data for updating an AuthN Mapping.

    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 87b423ce013..6b98fca9419 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: Configuration, requestFactory?: AuthNMappingsApiRequestFactory, responseProcessor?: AuthNMappingsApiResponseProcessor): AuthNMappingsApi

    Properties

    Private configuration

    configuration: 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

    downloadCloudWorkloadPolicyFile

    getCloudWorkloadSecurityAgentRule

    getCloudWorkloadSecurityAgentRule

    listCloudWorkloadSecurityAgentRules

    Returns Promise<CloudWorkloadSecurityAgentRuleResponse>

    listCloudWorkloadSecurityAgentRules

    updateCloudWorkloadSecurityAgentRule

    updateCloudWorkloadSecurityAgentRule

    getDashboardListItems

    updateDashboardListItems

    Returns Promise<DashboardListItems>

    updateDashboardListItems

    searchEventsWithPagination

    Legend

    • Constructor
    • Method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsListRequest.html b/classes/v2.EventsListRequest.html index 7f20a056a89..46b7207c469 100644 --- a/classes/v2.EventsListRequest.html +++ b/classes/v2.EventsListRequest.html @@ -1,12 +1,12 @@ EventsListRequest | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsListRequest

    The object sent with the request to retrieve a list of events from your organization.

    -

    Hierarchy

    • EventsListRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: EventsQueryFilter
    +

    Hierarchy

    • EventsListRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional filter

    filter?: EventsQueryFilter

    The search and filter query settings.

    -

    Optional options

    options?: EventsQueryOptions
    +

    Optional options

    options?: EventsQueryOptions

    The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.

    -

    Optional page

    page?: EventsRequestPage
    +

    Optional page

    page?: EventsRequestPage

    Pagination settings.

    -

    Optional sort

    sort?: EventsSort
    +

    Optional sort

    sort?: EventsSort

    The sort parameters when querying events.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsListResponse.html b/classes/v2.EventsListResponse.html index 5897b963f76..cc77193a35b 100644 --- a/classes/v2.EventsListResponse.html +++ b/classes/v2.EventsListResponse.html @@ -1,9 +1,9 @@ EventsListResponse | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsListResponse

    The response object with all events matching the request and pagination information.

    -

    Hierarchy

    • EventsListResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: v2.EventResponse[]
    +

    Hierarchy

    • EventsListResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: v2.EventResponse[]

    An array of events matching the request.

    -

    Optional links

    links?: EventsListResponseLinks
    +

    Optional links

    links?: EventsListResponseLinks

    Links attributes.

    -

    Optional meta

    meta?: EventsResponseMetadata
    +

    Optional meta

    meta?: EventsResponseMetadata

    The metadata associated with a request.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsListResponseLinks.html b/classes/v2.EventsListResponseLinks.html index 4daf35a4329..64ba6a3df58 100644 --- a/classes/v2.EventsListResponseLinks.html +++ b/classes/v2.EventsListResponseLinks.html @@ -1,6 +1,6 @@ EventsListResponseLinks | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsListResponseLinks

    Links attributes.

    -

    Hierarchy

    • EventsListResponseLinks

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional next

    next?: string
    +

    Hierarchy

    • EventsListResponseLinks

    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.EventsQueryFilter.html b/classes/v2.EventsQueryFilter.html index 53aa11aa3d0..cd3cacade9c 100644 --- a/classes/v2.EventsQueryFilter.html +++ b/classes/v2.EventsQueryFilter.html @@ -1,9 +1,9 @@ EventsQueryFilter | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsQueryFilter

    The search and filter query settings.

    -

    Hierarchy

    • EventsQueryFilter

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional from

    from?: string
    +

    Hierarchy

    • EventsQueryFilter

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional from

    from?: string

    The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.

    -

    Optional query

    query?: string
    +

    Optional query

    query?: string

    The search query following the event search syntax.

    -

    Optional to

    to?: string
    +

    Optional to

    to?: string

    The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsQueryOptions.html b/classes/v2.EventsQueryOptions.html index 53bea310969..6bf11f920d1 100644 --- a/classes/v2.EventsQueryOptions.html +++ b/classes/v2.EventsQueryOptions.html @@ -1,8 +1,8 @@ EventsQueryOptions | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsQueryOptions

    The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.

    -

    Hierarchy

    • EventsQueryOptions

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional timeOffset

    timeOffset?: number
    +

    Hierarchy

    • EventsQueryOptions

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional timeOffset

    timeOffset?: number

    The time offset to apply to the query in seconds.

    -

    Optional timezone

    timezone?: string
    +

    Optional timezone

    timezone?: string

    The timezone can be specified as an offset, for example: UTC+03:00.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsRequestPage.html b/classes/v2.EventsRequestPage.html index 9ebfa2e85b3..543abd961a3 100644 --- a/classes/v2.EventsRequestPage.html +++ b/classes/v2.EventsRequestPage.html @@ -1,7 +1,7 @@ EventsRequestPage | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsRequestPage

    Pagination settings.

    -

    Hierarchy

    • EventsRequestPage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional cursor

    cursor?: string
    +

    Hierarchy

    • EventsRequestPage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional cursor

    cursor?: string

    The returned paging point to use to get the next results.

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    The 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.EventsResponseMetadata.html b/classes/v2.EventsResponseMetadata.html index 52a91b778e5..d1702146aee 100644 --- a/classes/v2.EventsResponseMetadata.html +++ b/classes/v2.EventsResponseMetadata.html @@ -1,12 +1,12 @@ EventsResponseMetadata | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsResponseMetadata

    The metadata associated with a request.

    -

    Hierarchy

    • EventsResponseMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional elapsed

    elapsed?: number
    +

    Hierarchy

    • EventsResponseMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional elapsed

    elapsed?: number

    The time elapsed in milliseconds.

    -

    Optional page

    page?: EventsResponseMetadataPage
    +

    Optional page

    page?: EventsResponseMetadataPage

    Pagination attributes.

    -

    Optional requestId

    requestId?: string
    +

    Optional requestId

    requestId?: string

    The identifier of the request.

    -

    Optional warnings

    warnings?: EventsWarning[]
    +

    Optional warnings

    warnings?: EventsWarning[]

    A list of warnings (non-fatal errors) encountered. Partial results might be returned if warnings are present in the response.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsResponseMetadataPage.html b/classes/v2.EventsResponseMetadataPage.html index c53d592dc38..98c351ea81e 100644 --- a/classes/v2.EventsResponseMetadataPage.html +++ b/classes/v2.EventsResponseMetadataPage.html @@ -1,6 +1,6 @@ EventsResponseMetadataPage | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsResponseMetadataPage

    Pagination attributes.

    -

    Hierarchy

    • EventsResponseMetadataPage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional after

    after?: string
    +

    Hierarchy

    • EventsResponseMetadataPage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional after

    after?: 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 page[cursor].

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.EventsWarning.html b/classes/v2.EventsWarning.html index ea8442d75ba..3e1bb45b675 100644 --- a/classes/v2.EventsWarning.html +++ b/classes/v2.EventsWarning.html @@ -1,9 +1,9 @@ EventsWarning | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventsWarning

    A warning message indicating something is wrong with the query.

    -

    Hierarchy

    • EventsWarning

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional code

    code?: string
    +

    Hierarchy

    • EventsWarning

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional code

    code?: string

    A unique code for this type of warning.

    -

    Optional detail

    detail?: string
    +

    Optional detail

    detail?: string

    A detailed explanation of this specific warning.

    -

    Optional title

    title?: string
    +

    Optional title

    title?: string

    A short human-readable summary of the warning.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.FullAPIKey.html b/classes/v2.FullAPIKey.html index 509180cafa3..6684e66105d 100644 --- a/classes/v2.FullAPIKey.html +++ b/classes/v2.FullAPIKey.html @@ -1,11 +1,11 @@ FullAPIKey | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class FullAPIKey

    Datadog API key.

    -

    Hierarchy

    • FullAPIKey

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: FullAPIKeyAttributes
    +

    Hierarchy

    • FullAPIKey

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: FullAPIKeyAttributes

    Attributes of a full API key.

    -

    Optional id

    id?: string
    +

    Optional id

    id?: string

    ID of the API key.

    -

    Optional relationships

    relationships?: APIKeyRelationships
    +

    Optional relationships

    relationships?: APIKeyRelationships

    Resources related to the API key.

    -

    Optional type

    type?: "api_keys"
    +

    Optional type

    type?: "api_keys"

    API Keys resource type.

    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 fe377477927..5310e79a2c4 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 c105af2add0..ad417bb38ff 100644 --- a/classes/v2.FullApplicationKey.html +++ b/classes/v2.FullApplicationKey.html @@ -1,11 +1,11 @@ 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
    +

    Hierarchy

    • FullApplicationKey

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: FullApplicationKeyAttributes

    Attributes of a full application key.

    -

    Optional id

    id?: string
    +

    Optional id

    id?: string

    ID of the application key.

    -

    Optional relationships

    relationships?: ApplicationKeyRelationships
    +

    Optional relationships

    relationships?: ApplicationKeyRelationships

    Resources related to the application key.

    -

    Optional type

    type?: "application_keys"
    +

    Optional type

    type?: "application_keys"

    Application Keys resource type.

    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 3beeac96bc6..f134ec8369d 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 b4c0fd1b62d..f1e4433c4f5 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 b0160eb987e..a411806a97f 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 88d09c93ffb..8c2a735244e 100644 --- a/classes/v2.HTTPLogItem.html +++ b/classes/v2.HTTPLogItem.html @@ -1,22 +1,22 @@ 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 additionalProperties

    additionalProperties?: {}
    +

    Hierarchy

    • HTTPLogItem

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional additionalProperties

    additionalProperties?: {}

    A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

    -

    Type declaration

    • [key: string]: string

    Optional ddsource

    ddsource?: string
    +

    Type declaration

    • [key: string]: string

    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.

    diff --git a/classes/v2.HourlyUsage.html b/classes/v2.HourlyUsage.html index de51a395275..8b50e4f2796 100644 --- a/classes/v2.HourlyUsage.html +++ b/classes/v2.HourlyUsage.html @@ -1,9 +1,9 @@ HourlyUsage | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class HourlyUsage

    Hourly usage for a product family for an org.

    -

    Hierarchy

    • HourlyUsage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: HourlyUsageAttributes
    +

    Hierarchy

    • HourlyUsage

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: HourlyUsageAttributes

    Attributes of hourly usage for a product family for an org for a time period.

    -

    Optional id

    id?: string
    +

    Optional id

    id?: string

    Unique ID of the response.

    -

    Optional type

    type?: "usage_timeseries"
    +

    Optional type

    type?: "usage_timeseries"

    Type of usage data.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.HourlyUsageAttributes.html b/classes/v2.HourlyUsageAttributes.html index 65ad0e6cb56..1a5d059e6e1 100644 --- a/classes/v2.HourlyUsageAttributes.html +++ b/classes/v2.HourlyUsageAttributes.html @@ -1,15 +1,15 @@ HourlyUsageAttributes | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class HourlyUsageAttributes

    Attributes of hourly usage for a product family for an org for a time period.

    -

    Hierarchy

    • HourlyUsageAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional measurements

    measurements?: HourlyUsageMeasurement[]
    +

    Hierarchy

    • HourlyUsageAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional measurements

    measurements?: HourlyUsageMeasurement[]

    List of the measured usage values for the product family for the org for the time period.

    -

    Optional orgName

    orgName?: string
    +

    Optional orgName

    orgName?: string

    The organization name.

    -

    Optional productFamily

    productFamily?: string
    +

    Optional productFamily

    productFamily?: string

    The product for which usage is being reported.

    -

    Optional publicId

    publicId?: string
    +

    Optional publicId

    publicId?: string

    The organization public ID.

    -

    Optional region

    region?: string
    +

    Optional region

    region?: string

    The region of the Datadog instance that the organization belongs to.

    -

    Optional timestamp

    timestamp?: Date
    +

    Optional timestamp

    timestamp?: Date

    Datetime in ISO-8601 format, UTC. The hour for the usage.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.HourlyUsageMeasurement.html b/classes/v2.HourlyUsageMeasurement.html index fd0a4de0946..64730412d46 100644 --- a/classes/v2.HourlyUsageMeasurement.html +++ b/classes/v2.HourlyUsageMeasurement.html @@ -1,7 +1,7 @@ HourlyUsageMeasurement | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class HourlyUsageMeasurement

    Usage amount for a given usage type.

    -

    Hierarchy

    • HourlyUsageMeasurement

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional usageType

    usageType?: string
    +

    Hierarchy

    • HourlyUsageMeasurement

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional usageType

    usageType?: string

    Type of usage.

    -

    Optional value

    value?: number
    +

    Optional value

    value?: number

    Contains the number measured for the given usage_type during the hour.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.HourlyUsageMetadata.html b/classes/v2.HourlyUsageMetadata.html index 355d2357681..5a68ad97df3 100644 --- a/classes/v2.HourlyUsageMetadata.html +++ b/classes/v2.HourlyUsageMetadata.html @@ -1,5 +1,5 @@ HourlyUsageMetadata | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class HourlyUsageMetadata

    The object containing document metadata.

    -

    Hierarchy

    • HourlyUsageMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional pagination

    pagination?: HourlyUsagePagination
    +

    Hierarchy

    • HourlyUsageMetadata

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional pagination

    pagination?: HourlyUsagePagination

    The metadata for the current pagination.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.HourlyUsagePagination.html b/classes/v2.HourlyUsagePagination.html index 86f98c57dd7..5408bc4ab7f 100644 --- a/classes/v2.HourlyUsagePagination.html +++ b/classes/v2.HourlyUsagePagination.html @@ -1,5 +1,5 @@ HourlyUsagePagination | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class HourlyUsagePagination

    The metadata for the current pagination.

    -

    Hierarchy

    • HourlyUsagePagination

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional nextRecordId

    nextRecordId?: string
    +

    Hierarchy

    • HourlyUsagePagination

    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/v2.HourlyUsageResponse.html b/classes/v2.HourlyUsageResponse.html index 655d6149acb..85f0d20bca6 100644 --- a/classes/v2.HourlyUsageResponse.html +++ b/classes/v2.HourlyUsageResponse.html @@ -1,7 +1,7 @@ HourlyUsageResponse | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class HourlyUsageResponse

    Hourly usage response.

    -

    Hierarchy

    • HourlyUsageResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: HourlyUsage[]
    +

    Hierarchy

    • HourlyUsageResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: HourlyUsage[]

    Response containing hourly usage.

    -

    Optional meta

    meta?: HourlyUsageMetadata
    +

    Optional meta

    meta?: HourlyUsageMetadata

    The object containing document metadata.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.IdPMetadataFormData.html b/classes/v2.IdPMetadataFormData.html index 0ab33ad36df..730835ab7d3 100644 --- a/classes/v2.IdPMetadataFormData.html +++ b/classes/v2.IdPMetadataFormData.html @@ -1,5 +1,5 @@ IdPMetadataFormData | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class IdPMetadataFormData

    The form data submitted to upload IdP metadata

    -

    Hierarchy

    • IdPMetadataFormData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional idpFile

    idpFile?: HttpFile
    +

    Hierarchy

    • IdPMetadataFormData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional idpFile

    idpFile?: HttpFile

    The IdP metadata XML file

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.IncidentCreateAttributes.html b/classes/v2.IncidentCreateAttributes.html index 93afc853089..0d49c97dd5a 100644 --- a/classes/v2.IncidentCreateAttributes.html +++ b/classes/v2.IncidentCreateAttributes.html @@ -1,13 +1,13 @@ IncidentCreateAttributes | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class IncidentCreateAttributes

    The incident's attributes for a create request.

    -

    Hierarchy

    • IncidentCreateAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    customerImpacted

    customerImpacted: boolean
    +

    Hierarchy

    • IncidentCreateAttributes

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    customerImpacted

    customerImpacted: boolean

    A flag indicating whether the incident caused customer impact.

    -

    Optional fields

    fields?: {}
    +

    Optional fields

    fields?: {}

    A condensed view of the user-defined fields for which to create initial selections.

    -

    Type declaration

    Optional initialCells

    initialCells?: IncidentTimelineCellCreateAttributes[]
    +

    Type declaration

    Optional initialCells

    initialCells?: IncidentTimelineCellCreateAttributes[]

    An array of initial timeline cells to be placed at the beginning of the incident timeline.

    -

    Optional notificationHandles

    notificationHandles?: IncidentNotificationHandle[]
    +

    Optional notificationHandles

    notificationHandles?: IncidentNotificationHandle[]

    Notification handles that will be notified of the incident at creation.

    -

    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.IncidentCreateData.html b/classes/v2.IncidentCreateData.html index 84b12362bf7..aa5fa707a2a 100644 --- a/classes/v2.IncidentCreateData.html +++ b/classes/v2.IncidentCreateData.html @@ -1,9 +1,9 @@ IncidentCreateData | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class IncidentCreateData

    Incident data for a create request.

    -

    Hierarchy

    • IncidentCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    attributes

    attributes: IncidentCreateAttributes
    +

    Hierarchy

    • IncidentCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    attributes

    attributes: IncidentCreateAttributes

    The incident's attributes for a create request.

    -

    Optional relationships

    relationships?: IncidentCreateRelationships
    +

    Optional relationships

    relationships?: IncidentCreateRelationships

    The relationships the incident will have with other resources once created.

    -

    type

    type: "incidents"
    +

    type

    type: "incidents"

    Incident resource type.

    Legend

    • Constructor
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/v2.IncidentCreateRelationships.html b/classes/v2.IncidentCreateRelationships.html index a705b7e2c75..4044780f52d 100644 --- a/classes/v2.IncidentCreateRelationships.html +++ b/classes/v2.IncidentCreateRelationships.html @@ -1,5 +1,5 @@ IncidentCreateRelationships | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class IncidentCreateRelationships

    The relationships the incident will have with other resources once created.

    -

    Hierarchy

    • IncidentCreateRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    commanderUser

    commanderUser: NullableRelationshipToUser
    +

    Hierarchy

    • IncidentCreateRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    commanderUser

    commanderUser: NullableRelationshipToUser

    Relationship to user.

    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 da03d59d7be..edaa67abd65 100644 --- a/classes/v2.IncidentCreateRequest.html +++ b/classes/v2.IncidentCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • IncidentCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: IncidentCreateData

    Incident data for a create request.

    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 d1f07e93b8d..e3f9fab25d6 100644 --- a/classes/v2.IncidentFieldAttributesMultipleValue.html +++ b/classes/v2.IncidentFieldAttributesMultipleValue.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • IncidentFieldAttributesMultipleValue

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional type

    type?: IncidentFieldAttributesValueType

    Type of the multiple value field definitions.

    -

    Optional value

    value?: string[]
    +

    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 7582c9e97e1..4f621b4580a 100644 --- a/classes/v2.IncidentFieldAttributesSingleValue.html +++ b/classes/v2.IncidentFieldAttributesSingleValue.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • IncidentFieldAttributesSingleValue

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional type

    type?: IncidentFieldAttributesSingleValueType

    Type of the single value field definitions.

    -

    Optional value

    value?: string
    +

    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 6c635006122..91e255f21ba 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 b33db5cf71d..252d1772f52 100644 --- a/classes/v2.IncidentResponse.html +++ b/classes/v2.IncidentResponse.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • IncidentResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: IncidentResponseData

    Incident data from a response.

    -

    Optional included

    included?: IncidentResponseIncludedItem[]
    +

    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 d63a3f191ae..587304ebfb4 100644 --- a/classes/v2.IncidentResponseAttributes.html +++ b/classes/v2.IncidentResponseAttributes.html @@ -1,41 +1,41 @@ 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 4ebcbc31b1d..b875cd26a4a 100644 --- a/classes/v2.IncidentResponseData.html +++ b/classes/v2.IncidentResponseData.html @@ -1,11 +1,11 @@ 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
    +

    Hierarchy

    • IncidentResponseData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: IncidentResponseAttributes

    The incident's attributes from a response.

    -

    id

    id: string
    +

    id

    id: string

    The incident's ID.

    -

    Optional relationships

    relationships?: IncidentResponseRelationships
    +

    Optional relationships

    relationships?: IncidentResponseRelationships

    The incident's relationships from a response.

    -

    type

    type: "incidents"
    +

    type

    type: "incidents"

    Incident resource type.

    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 4123fb7a796..314fe311ad2 100644 --- a/classes/v2.IncidentResponseMeta.html +++ b/classes/v2.IncidentResponseMeta.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • IncidentResponseMeta

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional pagination

    pagination?: IncidentResponseMetaPagination

    Pagination properties.

    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 3a1319d0f3f..c9b7809ff18 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 fe7ebe92914..a4763980d82 100644 --- a/classes/v2.IncidentResponseRelationships.html +++ b/classes/v2.IncidentResponseRelationships.html @@ -1,13 +1,13 @@ 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
    +

    Hierarchy

    • IncidentResponseRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional commanderUser

    commanderUser?: NullableRelationshipToUser

    Relationship to user.

    -

    Optional createdByUser

    createdByUser?: RelationshipToUser
    +

    Optional createdByUser

    createdByUser?: RelationshipToUser

    Relationship to user.

    -

    Optional integrations

    integrations?: RelationshipToIncidentIntegrationMetadatas
    +

    Optional integrations

    integrations?: RelationshipToIncidentIntegrationMetadatas

    A relationship reference for multiple integration metadata objects.

    -

    Optional lastModifiedByUser

    lastModifiedByUser?: RelationshipToUser
    +

    Optional lastModifiedByUser

    lastModifiedByUser?: RelationshipToUser

    Relationship to user.

    -

    Optional postmortem

    postmortem?: RelationshipToIncidentPostmortem
    +

    Optional postmortem

    postmortem?: RelationshipToIncidentPostmortem

    A relationship reference for postmortems.

    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 96feee2b7c1..d492153668c 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 0e5556c12ab..e2fb858c474 100644 --- a/classes/v2.IncidentServiceCreateData.html +++ b/classes/v2.IncidentServiceCreateData.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • IncidentServiceCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: IncidentServiceCreateAttributes

    The incident service's attributes for a create request.

    -

    Optional relationships

    relationships?: IncidentServiceRelationships
    +

    Optional relationships

    relationships?: IncidentServiceRelationships

    The incident service's relationships.

    -

    type

    type: "services"
    +

    type

    type: "services"

    Incident service resource type.

    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 8b08cb4d53e..eaa6e9a8f9c 100644 --- a/classes/v2.IncidentServiceCreateRequest.html +++ b/classes/v2.IncidentServiceCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • IncidentServiceCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: IncidentServiceCreateData

    Incident Service payload for create requests.

    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 204376e4428..ca836d6773a 100644 --- a/classes/v2.IncidentServiceRelationships.html +++ b/classes/v2.IncidentServiceRelationships.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • IncidentServiceRelationships

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional createdBy

    createdBy?: RelationshipToUser

    Relationship to user.

    -

    Optional lastModifiedBy

    lastModifiedBy?: RelationshipToUser
    +

    Optional lastModifiedBy

    lastModifiedBy?: RelationshipToUser

    Relationship to user.

    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 b0b601e12bf..57a14c19de5 100644 --- a/classes/v2.IncidentServiceResponse.html +++ b/classes/v2.IncidentServiceResponse.html @@ -1,7 +1,7 @@ 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
    +

    Hierarchy

    • IncidentServiceResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: IncidentServiceResponseData

    Incident Service data from responses.

    -

    Optional included

    included?: IncidentServiceIncludedItems[]
    +

    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 a0f6c9d9a9a..2777036a432 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 90ce2b6d27e..d894f6e7de2 100644 --- a/classes/v2.IncidentServiceResponseData.html +++ b/classes/v2.IncidentServiceResponseData.html @@ -1,11 +1,11 @@ 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
    +

    Hierarchy

    • IncidentServiceResponseData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: IncidentServiceResponseAttributes

    The incident service's attributes from a response.

    -

    id

    id: string
    +

    id

    id: string

    The incident service's ID.

    -

    Optional relationships

    relationships?: IncidentServiceRelationships
    +

    Optional relationships

    relationships?: IncidentServiceRelationships

    The incident service's relationships.

    -

    type

    type: "services"
    +

    type

    type: "services"

    Incident service resource type.

    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 a2ae03dcc06..64f0a17d060 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 61cd54b9cdf..f965745b40d 100644 --- a/classes/v2.IncidentServiceUpdateData.html +++ b/classes/v2.IncidentServiceUpdateData.html @@ -1,11 +1,11 @@ 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
    +

    Hierarchy

    • IncidentServiceUpdateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: IncidentServiceUpdateAttributes

    The incident service's attributes for an update request.

    -

    Optional id

    id?: string
    +

    Optional id

    id?: string

    The incident service's ID.

    -

    Optional relationships

    relationships?: IncidentServiceRelationships
    +

    Optional relationships

    relationships?: IncidentServiceRelationships

    The incident service's relationships.

    -

    type

    type: "services"
    +

    type

    type: "services"

    Incident service resource type.

    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 27d7929168c..798411a737c 100644 --- a/classes/v2.IncidentServiceUpdateRequest.html +++ b/classes/v2.IncidentServiceUpdateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • IncidentServiceUpdateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: IncidentServiceUpdateData

    Incident Service payload for update requests.

    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 0a21add6a2f..036778f3c20 100644 --- a/classes/v2.IncidentServicesApi.html +++ b/classes/v2.IncidentServicesApi.html @@ -1,21 +1,21 @@ -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: Configuration, requestFactory?: IncidentServicesApiRequestFactory, responseProcessor?: IncidentServicesApiResponseProcessor): IncidentServicesApi

    Properties

    Private configuration

    configuration: 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

    getIncidentTeam

    listIncidentTeams

    Returns Promise<IncidentTeamResponse>

    listIncidentTeams

    updateIncidentTeam

    Returns Promise<IncidentTeamsResponse>

    updateIncidentTeam

    getIncident

    listIncidents

    Returns Promise<IncidentResponse>

    listIncidents

    listIncidentsWithPagination

    Returns Promise<IncidentsResponse>

    listIncidentsWithPagination

    updateIncident

    updateIncident

    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

    listLogsGet

    listLogsGetWithPagination

    Returns Promise<v2.LogsListResponse>

    listLogsGetWithPagination

    listLogsWithPagination

    listLogsWithPagination

    submitLog

    submitLog

    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

    getLogsMetric

    listLogsMetrics

    Returns Promise<LogsMetricResponse>

    listLogsMetrics

    updateLogsMetric

    updateLogsMetric

    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 metricType

    metricType?: MetricTagConfigurationMetricTypes

    The metric's type.

    -

    Optional modifiedAt

    modifiedAt?: Date
    +

    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 eabb739c0ca..22e18b5af12 100644 --- a/classes/v2.MetricTagConfigurationCreateAttributes.html +++ b/classes/v2.MetricTagConfigurationCreateAttributes.html @@ -1,6 +1,6 @@ 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. @@ -17,11 +17,11 @@

  • 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
    +

    metricType

    metricType: MetricTagConfigurationMetricTypes

    The metric's type.

    -

    tags

    tags: string[]
    +

    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 94b07f44205..dae9c80b8bd 100644 --- a/classes/v2.MetricTagConfigurationCreateData.html +++ b/classes/v2.MetricTagConfigurationCreateData.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • MetricTagConfigurationCreateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: MetricTagConfigurationCreateAttributes

    Object containing the definition of a metric tag configuration to be created.

    -

    id

    id: string
    +

    id

    id: string

    The metric name for this resource.

    -

    type

    type: "manage_tags"
    +

    type

    type: "manage_tags"

    The metric tag configuration resource type.

    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 09215d8d0e8..13a52f0e852 100644 --- a/classes/v2.MetricTagConfigurationCreateRequest.html +++ b/classes/v2.MetricTagConfigurationCreateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • MetricTagConfigurationCreateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: MetricTagConfigurationCreateData

    Object for a single metric to be configure tags on.

    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 d2b1798b922..52156b43a30 100644 --- a/classes/v2.MetricTagConfigurationResponse.html +++ b/classes/v2.MetricTagConfigurationResponse.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • MetricTagConfigurationResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: MetricTagConfiguration

    Object for a single metric tag configuration.

    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 67a8ea60994..8038cdd9101 100644 --- a/classes/v2.MetricTagConfigurationUpdateAttributes.html +++ b/classes/v2.MetricTagConfigurationUpdateAttributes.html @@ -1,6 +1,6 @@ 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. @@ -17,9 +17,9 @@

  • 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 10d55d3291e..5ca78b70e1f 100644 --- a/classes/v2.MetricTagConfigurationUpdateData.html +++ b/classes/v2.MetricTagConfigurationUpdateData.html @@ -1,9 +1,9 @@ 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
    +

    Hierarchy

    • MetricTagConfigurationUpdateData

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional attributes

    attributes?: MetricTagConfigurationUpdateAttributes

    Object containing the definition of a metric tag configuration to be updated.

    -

    id

    id: string
    +

    id

    id: string

    The metric name for this resource.

    -

    type

    type: "manage_tags"
    +

    type

    type: "manage_tags"

    The metric tag configuration resource type.

    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 291aaa9737d..1dbe85ab5fc 100644 --- a/classes/v2.MetricTagConfigurationUpdateRequest.html +++ b/classes/v2.MetricTagConfigurationUpdateRequest.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • MetricTagConfigurationUpdateRequest

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    data

    data: MetricTagConfigurationUpdateData

    Object for a single tag configuration to be edited.

    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 b7586448cf9..c2f1b9b5de2 100644 --- a/classes/v2.MetricVolumesResponse.html +++ b/classes/v2.MetricVolumesResponse.html @@ -1,5 +1,5 @@ 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
    +

    Hierarchy

    • MetricVolumesResponse

    Index

    Constructors

    Properties

    Constructors

    constructor

    Properties

    Optional data

    data?: MetricVolumes

    Possible response objects for a metric's volume.

    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 043d5627a8b..58a498201dc 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 823c95d99a7..30d7d7310db 100644 --- a/classes/v2.MetricsApi.html +++ b/classes/v2.MetricsApi.html @@ -1,4 +1,4 @@ -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: Configuration, requestFactory?: MetricsApiRequestFactory, responseProcessor?: MetricsApiResponseProcessor): v2.MetricsApi

    Properties

    Private configuration

    configuration: Configuration

    Private requestFactory

    requestFactory: MetricsApiRequestFactory

    Private responseProcessor

    responseProcessor: MetricsApiResponseProcessor

    Methods

    createBulkTagsMetricsConfiguration

    createTagConfiguration

    deleteBulkTagsMetricsConfiguration

    Returns Promise<MetricTagConfigurationResponse>

    deleteBulkTagsMetricsConfiguration

    deleteTagConfiguration

    Returns Promise<MetricBulkTagConfigResponse>

    deleteTagConfiguration

    estimateMetricsOutputSeries

    Returns Promise<void>

    estimateMetricsOutputSeries

    listTagConfigurationByName

    Returns Promise<MetricEstimateResponse>

    listTagConfigurationByName

    listTagConfigurations

    Returns Promise<MetricTagConfigurationResponse>

    listTagConfigurations

    listTagsByMetricName

    Returns Promise<MetricsAndMetricTagConfigurationsResponse>

    listTagsByMetricName

    listVolumesByMetricName

    Returns Promise<MetricAllTagsResponse>

    listVolumesByMetricName

    submitMetrics

    Returns Promise<MetricVolumesResponse>

    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 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes).

      If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:

      @@ -62,7 +62,7 @@

      Host name is one of the resources in the Resources field.

      Parameters

      Returns Promise<v2.IntakePayloadAccepted>

    updateTagConfiguration

    Returns Promise<v2.IntakePayloadAccepted>

    updateTagConfiguration

    listOpsgenieServices

    updateOpsgenieService

    updateOpsgenieService

    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

    deleteSecurityFilter

    deleteSecurityMonitoringRule

    Returns Promise<void>

    deleteSecurityMonitoringRule

    editSecurityMonitoringSignalAssignee

    Returns Promise<void>

    editSecurityMonitoringSignalAssignee

    editSecurityMonitoringSignalIncidents

    Returns Promise<SecurityMonitoringSignalTriageUpdateResponse>

    editSecurityMonitoringSignalIncidents

    editSecurityMonitoringSignalState

    Returns Promise<SecurityMonitoringSignalTriageUpdateResponse>

    editSecurityMonitoringSignalState

    getSecurityFilter

    Returns Promise<SecurityMonitoringSignalTriageUpdateResponse>

    getSecurityFilter

    getSecurityMonitoringRule

    Returns Promise<SecurityFilterResponse>

    getSecurityMonitoringRule

    listSecurityFilters

    Returns Promise<SecurityMonitoringRuleResponse>

    listSecurityFilters

    listSecurityMonitoringRules

    listSecurityMonitoringRules

    listSecurityMonitoringSignals

    Returns Promise<SecurityMonitoringListRulesResponse>

    listSecurityMonitoringSignals

    listSecurityMonitoringSignalsWithPagination

    Returns Promise<SecurityMonitoringSignalsListResponse>

    listSecurityMonitoringSignalsWithPagination

    searchSecurityMonitoringSignals

    searchSecurityMonitoringSignals

    searchSecurityMonitoringSignalsWithPagination

    Returns Promise<SecurityMonitoringSignalsListResponse>

    searchSecurityMonitoringSignalsWithPagination

    updateSecurityFilter

    updateSecurityFilter

    updateSecurityMonitoringRule

    Returns Promise<SecurityFilterResponse>

    updateSecurityMonitoringRule

    getServiceAccountApplicationKey

    listServiceAccountApplicationKeys

    Returns Promise<PartialApplicationKeyResponse>

    listServiceAccountApplicationKeys

    updateServiceAccountApplicationKey

    Returns Promise<ListApplicationKeysResponse>

    updateServiceAccountApplicationKey

    getHourlyUsage

    getUsageApplicationSecurityMonitoring

    Returns Promise<HourlyUsageResponse>

    getUsageApplicationSecurityMonitoring

    getUsageLambdaTracedInvocations

    Returns Promise<UsageApplicationSecurityMonitoringResponse>

    getUsageLambdaTracedInvocations

    getUsageObservabilityPipelines

    Returns Promise<UsageLambdaTracedInvocationsResponse>

    getUsageObservabilityPipelines

    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

    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/client.AbortSignal.html b/interfaces/client.AbortSignal.html index 1a4a241b328..a0bbab7c4f4 100644 --- a/interfaces/client.AbortSignal.html +++ b/interfaces/client.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/client.Configuration.html b/interfaces/client.Configuration.html index d578bc809d6..dfe8c537b19 100644 --- a/interfaces/client.Configuration.html +++ b/interfaces/client.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: AuthMethods

    Optional Readonly baseServer

    baseServer?: BaseServerConfiguration

    Readonly debug

    debug: undefined | boolean

    Readonly httpApi

    httpApi: HttpLibrary

    Readonly httpConfig

    httpConfig: 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: AuthMethods

    Optional Readonly baseServer

    baseServer?: BaseServerConfiguration

    Readonly debug

    debug: undefined | boolean

    Readonly httpApi

    httpApi: HttpLibrary

    Readonly httpConfig

    httpConfig: 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/client.HttpConfiguration.html b/interfaces/client.HttpConfiguration.html index d2fee29273f..8149194ca24 100644 --- a/interfaces/client.HttpConfiguration.html +++ b/interfaces/client.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?: 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?: AbortSignal

    Legend

    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/client.HttpLibrary.html b/interfaces/client.HttpLibrary.html index 687134a5633..07010463b27 100644 --- a/interfaces/client.HttpLibrary.html +++ b/interfaces/client.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/client.ResponseBody.html b/interfaces/client.ResponseBody.html index 59981166ebd..28acaa0d0b5 100644 --- a/interfaces/client.ResponseBody.html +++ b/interfaces/client.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/client.SecurityAuthentication.html b/interfaces/client.SecurityAuthentication.html index a82a9af1d4e..0ed27b3c84a 100644 --- a/interfaces/client.SecurityAuthentication.html +++ b/interfaces/client.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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/client.TokenProvider.html b/interfaces/client.TokenProvider.html index 0008f58127d..ab7b0316547 100644 --- a/interfaces/client.TokenProvider.html +++ b/interfaces/client.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>

    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>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/v1.AWSIntegrationApiCreateAWSAccountRequest.html b/interfaces/v1.AWSIntegrationApiCreateAWSAccountRequest.html index 32b314c8db2..7569cfcdd9c 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 c9725be6595..346ee2bf40d 100644 --- a/interfaces/v1.AWSIntegrationApiCreateAWSTagFilterRequest.html +++ b/interfaces/v1.AWSIntegrationApiCreateAWSTagFilterRequest.html @@ -1,4 +1,4 @@ -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 efec5dc4c48..30e34a1163b 100644 --- a/interfaces/v1.AWSIntegrationApiCreateNewAWSExternalIDRequest.html +++ b/interfaces/v1.AWSIntegrationApiCreateNewAWSExternalIDRequest.html @@ -1,4 +1,4 @@ -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.

    diff --git a/interfaces/v1.AWSIntegrationApiDeleteAWSAccountRequest.html b/interfaces/v1.AWSIntegrationApiDeleteAWSAccountRequest.html index afd1c0189ca..ccbee423313 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 bfb30a88dcb..d3c91baf0bc 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 74c9d5df95b..be22adf3a5c 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 21a09f377f2..6b9693e1ebe 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 4f8c9dc5fcd..38dd94e2b77 100644 --- a/interfaces/v1.AWSIntegrationApiUpdateAWSAccountRequest.html +++ b/interfaces/v1.AWSIntegrationApiUpdateAWSAccountRequest.html @@ -1,11 +1,11 @@ -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 a0f0847084c..ce5c065161b 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 36511797d4d..b983e88d810 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 8b2db15edb6..3063299ff4f 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 7e84a8de7f6..f44025ec2d4 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 6953671a21e..1a73adaeefc 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.AzureIntegrationApiCreateAzureIntegrationRequest.html b/interfaces/v1.AzureIntegrationApiCreateAzureIntegrationRequest.html index 3719bc89ef5..247aa91a13e 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 d62ef36ba89..1ba58b9e234 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 87b46368654..389bf3bdcc4 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 b9d848e6067..c41b3df429e 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.DashboardListsApiCreateDashboardListRequest.html b/interfaces/v1.DashboardListsApiCreateDashboardListRequest.html index 09047ddeb01..a984358c5bb 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 b67ba4f43bc..6f07887885a 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 e07b712d690..a407dd9daf8 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 2d06630eabd..6819e4abab9 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 f896b51ed7b..159358d61a5 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 d6412bcc9fe..8e7df12cd2b 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 37bc04c3390..72b6d6eef69 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 40da098ce25..5dd1e71d6c1 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 a6a900133cb..34dd74c8572 100644 --- a/interfaces/v1.DashboardsApiListDashboardsRequest.html +++ b/interfaces/v1.DashboardsApiListDashboardsRequest.html @@ -1,7 +1,7 @@ -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 cdfc9e7cbb7..b276ed83bdc 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 e014cfd5420..5c837e18549 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 136ab2dc1bb..d6f4d73ddc2 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 0c39cdead64..c0123e09cb2 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 6fd96347f22..44c9e9e003b 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 435cedb9f90..dc59e9e2320 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 2f057f325dc..c505ee4e354 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 6355dfd1c52..74aa9332ecd 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 1e6052dd1b4..a150259221d 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 6025c737eef..71390991fc2 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 0dd453d6650..04ccc7ffae1 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 b77be49f9a1..c916c0b9cdc 100644 --- a/interfaces/v1.EventsApiListEventsRequest.html +++ b/interfaces/v1.EventsApiListEventsRequest.html @@ -1,20 +1,20 @@ -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?: v1.EventPriority
    +

    Optional priority

    priority?: v1.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.

    diff --git a/interfaces/v1.GCPIntegrationApiCreateGCPIntegrationRequest.html b/interfaces/v1.GCPIntegrationApiCreateGCPIntegrationRequest.html index 97125fcce75..02fea6b0ed6 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 35f4a75c605..6186b2e7476 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 1f43d6ee0df..4fc1cc5a4d5 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 9d6383162b9..30810c74a95 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 dadfbd364d6..7653efdbba2 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 d13c9fad70a..f878a196a27 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 299ead42aa9..68376c7bc87 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.KeyManagementApiCreateAPIKeyRequest.html b/interfaces/v1.KeyManagementApiCreateAPIKeyRequest.html index f4a874dfe2c..5c8d682682c 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 47a5b3b906a..2ecd224fdc0 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 d452d616e42..ae5a37522fb 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 2f43aed41bf..5ef77331b94 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 358220da080..92b267036f6 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 0e508928a42..3d009bc828f 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 a27492cb4bc..8229d80c266 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 bae48889958..4810f65fbfa 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 282302c25ec..2861f15c913 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 8b020ac1f44..c17668d96d4 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 796b77e29cb..2918f377c66 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 b8c0a2e549a..bc2b502d6cd 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 e1cf43be675..2f36d83d900 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 654411eae42..b4ac30e4c9a 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 bcdd281af43..61af3083a45 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 b25ebdbfc33..3d76864261d 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 e108b89f0ba..68230bfc1b0 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 0f661abf474..ceaef1dff4f 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 3b8433b5148..603832109a0 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 9387211ef44..d589bda1ca8 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 8c3b60da6e3..d9dc13c8ce8 100644 --- a/interfaces/v1.MetricsApiListActiveMetricsRequest.html +++ b/interfaces/v1.MetricsApiListActiveMetricsRequest.html @@ -1,9 +1,9 @@ -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 01ea2b3e90a..f3e408ccc67 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. Can optionally 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 898b9550d70..ff33ae82856 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.MetricsApiSubmitDistributionPointsRequest.html b/interfaces/v1.MetricsApiSubmitDistributionPointsRequest.html index d2cd08955a7..caba759c110 100644 --- a/interfaces/v1.MetricsApiSubmitDistributionPointsRequest.html +++ b/interfaces/v1.MetricsApiSubmitDistributionPointsRequest.html @@ -1,3 +1,3 @@ -MetricsApiSubmitDistributionPointsRequest | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MetricsApiSubmitDistributionPointsRequest

    Hierarchy

    • MetricsApiSubmitDistributionPointsRequest

    Index

    Properties

    Properties

    body

    body: DistributionPointsPayload

    Optional contentEncoding

    contentEncoding?: "deflate"
    +MetricsApiSubmitDistributionPointsRequest | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MetricsApiSubmitDistributionPointsRequest

    Hierarchy

    • MetricsApiSubmitDistributionPointsRequest

    Index

    Properties

    Properties

    body

    body: DistributionPointsPayload

    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.MetricsApiSubmitMetricsRequest.html b/interfaces/v1.MetricsApiSubmitMetricsRequest.html index d7ebe96f27d..b8b12be0f1a 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 e0caaff59bd..4a0553812f6 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: v1.MetricMetadata
    +MetricsApiUpdateMetricMetadataRequest | datadog-api-client-typescript
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MetricsApiUpdateMetricMetadataRequest

    Hierarchy

    • MetricsApiUpdateMetricMetadataRequest

    Index

    Properties

    Properties

    body

    body: v1.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 c6977836bfa..6f6f7147d56 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 e1e8cec6279..d622f6817b4 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 18e37fb864c..35d71cf29e7 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 bf2b3c7589f..e2ff554f487 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 3c995360a02..55e9b8e2fb1 100644 --- a/interfaces/v1.MonitorsApiListMonitorsRequest.html +++ b/interfaces/v1.MonitorsApiListMonitorsRequest.html @@ -1,20 +1,20 @@ -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 6a3467e0e00..a4314a9c127 100644 --- a/interfaces/v1.MonitorsApiSearchMonitorGroupsRequest.html +++ b/interfaces/v1.MonitorsApiSearchMonitorGroupsRequest.html @@ -1,13 +1,13 @@ -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="type:metric status:alert".

    -

    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: