influxdb-client-js

InfluxDB 2.0 JavaScript client

View the Project on GitHub influxdata/influxdb-client-js

Home > @influxdata/influxdb-client-apis

influxdb-client-apis package

Classes

Class Description
AuthorizationsAPI Authorizations API
BackupAPI Backup API
BucketsAPI Buckets API
ChecksAPI Checks API
ConfigAPI Config API
DashboardsAPI Dashboards API
DbrpsAPI Dbrps API
DebugAPI Debug API
DeleteAPI Delete API
FlagsAPI Flags API
FluxScriptInvocationAPI FluxScriptInvocationAPI executes flux ‘API invokable script’ and parses the result CSV annotated data. See https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/ .
HealthAPI Health API
LabelsAPI Labels API
MeAPI Me API
MetricsAPI Metrics API
NotificationEndpointsAPI NotificationEndpoints API
NotificationRulesAPI NotificationRules API
OrgsAPI Orgs API
PingAPI Ping API
QueryAPI Query API
ReadyAPI Ready API
RemotesAPI Remotes API
ReplicationsAPI Replications API
ResourcesAPI Resources API
RestoreAPI Restore API
RootAPI Root API
ScrapersAPI Scrapers API
ScriptsAPI Scripts API
SetupAPI Setup API
SigninAPI Signin API
SignoutAPI Signout API
SourcesAPI Sources API
StacksAPI Stacks API
TasksAPI Tasks API
TelegrafAPI Telegraf API
TelegrafsAPI Telegrafs API
TemplatesAPI Templates API
UsersAPI Users API
VariablesAPI Variables API
WriteAPI Write API

Interfaces

Interface Description
AddResourceMemberRequestBody  
AnalyzeQueryResponse  
ApplyTemplateRequest  
ArrayExpression Used to create and directly specify the elements of an array object
ASTResponse Contains the AST for the supplied Flux query
Authorizations  
AuthorizationUpdateRequest  
Axes The viewport for a View’s visualizations
Axis Axis used in a visualization.
BadStatement A placeholder for statements for which no correct statement nodes can be created
BandViewProperties  
BinaryExpression uses binary operators to act on two operands in an expression
Block A set of statements
BooleanLiteral Represents boolean values
Bucket  
BucketMetadataManifest  
Buckets  
BucketShardMapping  
BuilderConfig  
BuilderFunctionsType  
BuilderTagsType  
BuiltinStatement Declares a builtin identifier and its type
CallExpression Represents a function call
Cell  
CellUpdate  
CheckBase  
CheckPatch  
Checks  
CheckViewProperties  
ConditionalExpression Selects one of two expressions, Alternate or Consequent, depending on a third boolean expression, Test
Config  
ConstantVariableProperties  
CreateCell  
CreateCheckRequest  
CreateDashboardRequest  
CreateNotificationEndpointRequest  
CreateNotificationRuleRequest  
CreateStackRequest  
DashboardColor Defines an encoding of data value into color space.
DashboardQuery  
Dashboards  
DateTimeLiteral Represents an instant in time with nanosecond precision in RFC3339Nano date/time format.
DBRP  
DBRPCreate  
DBRPGet  
DBRPs  
DBRPUpdate  
DecimalPlaces Indicates whether decimal places should be enforced, and how many digits it should show.
DeleteAuthorizationsIDRequest  
DeleteBucketsIDLabelsIDRequest  
DeleteBucketsIDMembersIDRequest  
DeleteBucketsIDOwnersIDRequest  
DeleteBucketsIDRequest  
DeleteChecksIDLabelsIDRequest  
DeleteChecksIDRequest  
DeleteDashboardsIDCellsIDRequest  
DeleteDashboardsIDLabelsIDRequest  
DeleteDashboardsIDMembersIDRequest  
DeleteDashboardsIDOwnersIDRequest  
DeleteDashboardsIDRequest  
DeleteDBRPIDRequest  
DeleteLabelsIDRequest  
DeleteNotificationEndpointsIDLabelsIDRequest  
DeleteNotificationEndpointsIDRequest  
DeleteNotificationRulesIDLabelsIDRequest  
DeleteNotificationRulesIDRequest  
DeleteOrgsIDMembersIDRequest  
DeleteOrgsIDOwnersIDRequest  
DeleteOrgsIDRequest  
DeleteOrgsIDSecretsIDRequest  
DeletePredicateRequest The delete predicate request.
DeleteRemoteConnectionByIDRequest  
DeleteReplicationByIDRequest  
DeleteScrapersIDLabelsIDRequest  
DeleteScrapersIDMembersIDRequest  
DeleteScrapersIDOwnersIDRequest  
DeleteScrapersIDRequest  
DeleteScriptsIDRequest  
DeleteSourcesIDRequest  
DeleteStackRequest  
DeleteTasksIDLabelsIDRequest  
DeleteTasksIDMembersIDRequest  
DeleteTasksIDOwnersIDRequest  
DeleteTasksIDRequest  
DeleteTasksIDRunsIDRequest  
DeleteTelegrafsIDLabelsIDRequest  
DeleteTelegrafsIDMembersIDRequest  
DeleteTelegrafsIDOwnersIDRequest  
DeleteTelegrafsIDRequest  
DeleteUsersIDRequest  
DeleteVariablesIDLabelsIDRequest  
DeleteVariablesIDRequest  
Dialect <p>Options for tabular data output. Default output is annotated CSV with headers.</p><p>For more information about tabular data **dialect**, see W3 metadata vocabulary for tabular data.</p>
DictExpression Used to create and directly specify the elements of a dictionary
DictItem A key-value pair in a dictionary.
Duration A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed.
DurationLiteral Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang’s time.Duration
Error_2  
ExecutionOptions ExecutionOptions contains execution options for a flux script.
ExportTemplateRequest  
ExpressionStatement May consist of an expression that doesn’t return a value and is executed solely for its side-effects
File Represents a source from a single file
FloatLiteral Represents floating point numbers according to the double representations defined by the IEEE-754-1985
FluxResponse Rendered flux that backs the check or notification.
FluxSuggestion  
FluxSuggestions  
FunctionExpression Function expression
GaugeViewProperties  
GeoViewLayerProperties  
GeoViewProperties  
GetAuthorizationsIDRequest  
GetAuthorizationsRequest  
GetBackupKVRequest  
GetBackupMetadataRequest  
GetBackupShardIdRequest  
GetBucketsIDLabelsRequest  
GetBucketsIDMembersRequest  
GetBucketsIDOwnersRequest  
GetBucketsIDRequest  
GetBucketsRequest  
GetChecksIDLabelsRequest  
GetChecksIDQueryRequest  
GetChecksIDRequest  
GetChecksRequest  
GetConfigRequest  
GetDashboardsIDCellsIDViewRequest  
GetDashboardsIDLabelsRequest  
GetDashboardsIDMembersRequest  
GetDashboardsIDOwnersRequest  
GetDashboardsIDRequest  
GetDashboardsRequest  
GetDBRPsIDRequest  
GetDBRPsRequest  
GetDebugPprofAllocsRequest  
GetDebugPprofAllProfilesRequest  
GetDebugPprofBlockRequest  
GetDebugPprofCmdlineRequest  
GetDebugPprofGoroutineRequest  
GetDebugPprofHeapRequest  
GetDebugPprofMutexRequest  
GetDebugPprofProfileRequest  
GetDebugPprofThreadCreateRequest  
GetDebugPprofTraceRequest  
GetFlagsRequest  
GetHealthRequest  
GetLabelsIDRequest  
GetLabelsRequest  
GetMeRequest  
GetMetricsRequest  
GetNotificationEndpointsIDLabelsRequest  
GetNotificationEndpointsIDRequest  
GetNotificationEndpointsRequest  
GetNotificationRulesIDLabelsRequest  
GetNotificationRulesIDQueryRequest  
GetNotificationRulesIDRequest  
GetNotificationRulesRequest  
GetOrgsIDMembersRequest  
GetOrgsIDOwnersRequest  
GetOrgsIDRequest  
GetOrgsIDSecretsRequest  
GetOrgsRequest  
GetPingRequest  
GetQuerySuggestionsNameRequest  
GetQuerySuggestionsRequest  
GetReadyRequest  
GetRemoteConnectionByIDRequest  
GetRemoteConnectionsRequest  
GetReplicationByIDRequest  
GetReplicationsRequest  
GetResourcesRequest  
GetRoutesRequest  
GetScrapersIDLabelsRequest  
GetScrapersIDMembersRequest  
GetScrapersIDOwnersRequest  
GetScrapersIDRequest  
GetScrapersRequest  
GetScriptsIDRequest  
GetScriptsRequest  
GetSetupRequest  
GetSourcesIDBucketsRequest  
GetSourcesIDHealthRequest  
GetSourcesIDRequest  
GetSourcesRequest  
GetTasksIDLabelsRequest  
GetTasksIDLogsRequest  
GetTasksIDMembersRequest  
GetTasksIDOwnersRequest  
GetTasksIDRequest  
GetTasksIDRunsIDLogsRequest  
GetTasksIDRunsIDRequest  
GetTasksIDRunsRequest  
GetTasksRequest  
GetTelegrafPluginsRequest  
GetTelegrafsIDLabelsRequest  
GetTelegrafsIDMembersRequest  
GetTelegrafsIDOwnersRequest  
GetTelegrafsIDRequest  
GetTelegrafsRequest  
GetUsersIDRequest  
GetUsersRequest  
GetVariablesIDLabelsRequest  
GetVariablesIDRequest  
GetVariablesRequest  
HealthCheck  
HeatmapViewProperties  
HistogramViewProperties  
HTTPNotificationRuleBase  
Identifier A valid Flux identifier
ImportDeclaration Declares a package import
IndexExpression Represents indexing into an array
IntegerLiteral Represents integer numbers
IsOnboarding  
Label  
LabelCreateRequest  
LabelMapping  
LabelResponse  
LabelsResponse  
LabelUpdate  
LanguageRequest Flux query to be analyzed.
LatLonColumn Object type for key and column definitions
LatLonColumns Object type to define lat/lon columns
LinePlusSingleStatProperties  
LineProtocolError  
LineProtocolLengthError  
Links URI pointers for additional paged results.
ListStacksRequest  
LogEvent  
LogicalExpression Represents the rule conditions that collectively evaluate to either true or false
Logs  
MapVariableProperties  
MarkdownViewProperties  
MemberAssignment Object property assignment
MemberExpression Represents accessing a property of an object
MetadataBackup  
MosaicViewProperties  
NotificationEndpointBase  
NotificationEndpoints  
NotificationEndpointUpdate  
NotificationRuleBase  
NotificationRules  
NotificationRuleUpdate  
ObjectExpression Allows the declaration of an anonymous object within a declaration
OnboardingRequest  
OnboardingResponse  
OptionStatement A single variable declaration
Organization  
Organizations  
Package Represents a complete package source tree.
PackageClause Defines a package identifier
PagerDutyNotificationRuleBase  
ParenExpression Represents an expression wrapped in parenthesis
PasswordResetBody  
PatchAuthorizationsIDRequest  
PatchBucketRequest An object that contains updated bucket properties to apply.
PatchBucketsIDRequest  
PatchChecksIDRequest  
PatchDashboardsIDCellsIDRequest  
PatchDashboardsIDCellsIDViewRequest  
PatchDashboardsIDRequest  
PatchDBRPIDRequest  
PatchLabelsIDRequest  
PatchNotificationEndpointsIDRequest  
PatchNotificationRulesIDRequest  
PatchOrganizationRequest An object that contains updated organization properties to apply.
PatchOrgsIDRequest  
PatchOrgsIDSecretsRequest  
PatchRemoteConnectionByIDRequest  
PatchReplicationByIDRequest  
PatchRetentionRule  
PatchScrapersIDRequest  
PatchScriptsIDAddLabelsRequest  
PatchScriptsIDRemoveLabelsRequest  
PatchScriptsIDRequest  
PatchSourcesIDRequest  
PatchTasksIDRequest  
PatchUsersIDRequest  
PatchVariablesIDRequest  
Permission  
PipeExpression Call expression with pipe argument
PipeLiteral Represents a specialized literal value, indicating the left hand value of a pipe expression
PostAuthorizationsRequest  
PostBucketRequest  
PostBucketsIDLabelsRequest  
PostBucketsIDMembersRequest  
PostBucketsIDOwnersRequest  
PostBucketsRequest  
PostChecksIDLabelsRequest  
PostDashboardsIDCellsRequest  
PostDashboardsIDLabelsRequest  
PostDashboardsIDMembersRequest  
PostDashboardsIDOwnersRequest  
PostDashboardsRequest  
PostDBRPRequest  
PostDeleteRequest  
PostLabelsRequest  
PostNotificationEndpointIDLabelsRequest  
PostNotificationRuleIDLabelsRequest  
PostOrganizationRequest  
PostOrgsIDMembersRequest  
PostOrgsIDOwnersRequest  
PostOrgsIDSecretsRequest  
PostOrgsRequest  
PostQueryAnalyzeRequest  
PostQueryAstRequest  
PostQueryRequest  
PostRemoteConnectionRequest  
PostReplicationRequest  
PostRestoreBucketIDRequest  
PostRestoreBucketMetadataRequest  
PostRestoreKVRequest  
PostRestoreShardIdRequest  
PostRestoreSQLRequest  
PostScrapersIDLabelsRequest  
PostScrapersIDMembersRequest  
PostScrapersIDOwnersRequest  
PostScrapersRequest  
PostScriptsIDInvokeRequest  
PostScriptsRequest  
PostSetupRequest  
PostSigninRequest  
PostSignoutRequest  
PostSourcesRequest  
PostTasksIDLabelsRequest  
PostTasksIDMembersRequest  
PostTasksIDOwnersRequest  
PostTasksIDRunsIDRetryRequest  
PostTasksIDRunsRequest  
PostTasksRequest  
PostTelegrafsIDLabelsRequest  
PostTelegrafsIDMembersRequest  
PostTelegrafsIDOwnersRequest  
PostTelegrafsRequest  
PostUsersIDPasswordRequest  
PostUsersRequest  
PostValidateReplicationByIDRequest  
PostVariablesIDLabelsRequest  
PostVariablesRequest  
PostWriteRequest  
Property The value associated with a key
PutChecksIDRequest  
PutDashboardsIDCellsRequest  
PutMePasswordRequest  
PutNotificationEndpointsIDRequest  
PutNotificationRulesIDRequest  
PutTelegrafsIDRequest  
PutVariablesIDRequest  
Query Query InfluxDB with the Flux language
QueryVariableProperties  
ReadStackRequest  
Ready  
RegexpLiteral Expressions begin and end with / and are regular expressions with syntax accepted by RE2
RemoteConnection  
RemoteConnectionCreationRequest  
RemoteConnections  
RemoteConnectionUpdateRequest  
RenamableField Describes a field that can be renamed and made visible or invisible.
Replication  
ReplicationCreationRequest  
Replications  
ReplicationUpdateRequest  
RequestOptions  
Resource  
ResourceMembers  
ResourceOwners  
RestoredBucketMappings  
RetentionPolicyManifest  
RetentionRule  
ReturnStatement Defines an expression to return
Routes  
Run  
RunManually  
Runs  
ScatterViewProperties  
ScraperTargetRequest  
ScraperTargetResponses  
Script  
ScriptCreateRequest  
ScriptInvocationParams  
Scripts  
ScriptUpdateRequest  
SecretKeys  
ShardGroupManifest  
ShardManifest  
ShardOwner  
SimpleTableViewProperties  
SingleStatViewProperties  
SlackNotificationRuleBase  
SMTPNotificationRuleBase  
Source  
Sources  
Stack  
StaticLegend StaticLegend represents the options specific to the static legend
StatusRule  
StringLiteral Expressions begin and end with double quote marks
SubscriptionManifest  
TableViewProperties  
TagRule  
Task  
TaskCreateRequest  
Tasks  
TaskUpdateRequest  
TelegrafPlugin  
TelegrafPluginRequest  
TelegrafPlugins  
TelegrafRequest  
Telegrafs  
TelegramNotificationRuleBase  
TemplateApply  
TemplateChart  
TemplateExportByID  
TemplateExportByName  
TemplateSummary  
TemplateSummaryLabel  
TestStatement Declares a Flux test case
ThresholdBase  
UnaryExpression Uses operators to act on a single operand in an expression
UninstallStackRequest  
UnsignedIntegerLiteral Represents integer numbers
UpdateStackRequest  
User  
UserResponse  
Users  
Variable  
VariableAssignment Represents the declaration of a variable
Variables  
View  
XYViewProperties  

Type Aliases

Type Alias Description
Authorization  
AuthorizationPostRequest  
AxisScale Scale is the axis formatting scale. Supported: “log”, “linear”
BucketMetadataManifests  
BucketShardMappings  
BuilderAggregateFunctionType  
Cells  
CellsWithViewProperties  
CellWithViewProperties  
Check  
CheckDiscriminator  
CheckStatusLevel The state to record if check matches a criteria.
ColorMapping A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
CustomCheck  
Dashboard  
DashboardWithViewProperties  
DeadmanCheck  
Expression  
Flags  
GeoCircleViewLayer  
GeoHeatMapViewLayer  
GeoPointMapViewLayer  
GeoTrackMapViewLayer  
GeoViewLayer  
GreaterThreshold  
HTTPNotificationEndpoint  
HTTPNotificationRule  
Labels  
LesserThreshold  
Link URI of resource.
Node  
NodeType Type of AST node
NotificationEndpoint  
NotificationEndpointDiscriminator  
NotificationEndpointType  
NotificationRule  
NotificationRuleDiscriminator  
PagerDutyNotificationEndpoint  
PagerDutyNotificationRule  
PatchRetentionRules Updates to rules to expire or retain data. No rules means no updates.
PostCheck  
PostNotificationEndpoint  
PostNotificationRule  
PropertyKey_2  
QueryEditMode  
RangeThreshold  
ResourceMember  
ResourceOwner  
RetentionPolicyManifests  
RetentionRules <p>Retention rules to expire or retain data. #### InfluxDB Cloud</p><p>- retentionRules is required.</p><p>#### InfluxDB OSS</p><p>- retentionRules isn’t required.</p>
RuleStatusLevel The state to record if check matches a criteria.
SchemaType  
ScraperTargetResponse  
ScriptHTTPResponseData The response body contains the results of the executed script. The response is user-defined and dynamic.
ScriptLanguage  
SecretKeysResponse  
Secrets  
ShardGroupManifests  
ShardManifests  
ShardOwners  
SlackNotificationEndpoint  
SlackNotificationRule  
SMTPNotificationRule  
Statement  
SubscriptionManifests  
TaskStatusType inactive cancels scheduled runs and prevents manual runs of the task.
Telegraf  
TelegramNotificationEndpoint  
TelegramNotificationRule  
Template  
TemplateEnvReferences  
TemplateKind  
Threshold  
ThresholdCheck  
VariableProperties  
ViewProperties  
XYGeom