• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • InfluxDBTraceFilter
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

Interface INotificationEndpointsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface INotificationEndpointsService : IApiAccessor

Methods

CreateNotificationEndpoint(NotificationEndpoint)

Add a notification endpoint

Declaration
NotificationEndpoint CreateNotificationEndpoint(NotificationEndpoint notificationEndpoint)
Parameters
Type Name Description
NotificationEndpoint notificationEndpoint

Notification endpoint to create

Returns
Type Description
NotificationEndpoint

NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

CreateNotificationEndpointAsync(NotificationEndpoint, CancellationToken)

Add a notification endpoint

Declaration
System.Threading.Tasks.Task<NotificationEndpoint> CreateNotificationEndpointAsync(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)
Parameters
Type Name Description
NotificationEndpoint notificationEndpoint

Notification endpoint to create

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<NotificationEndpoint>

Task of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

CreateNotificationEndpointAsyncWithHttpInfo(NotificationEndpoint, CancellationToken)

Add a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> CreateNotificationEndpointAsyncWithHttpInfo(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)
Parameters
Type Name Description
NotificationEndpoint notificationEndpoint

Notification endpoint to create

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>>

Task of ApiResponse (NotificationEndpoint)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

CreateNotificationEndpointWithHttpInfo(NotificationEndpoint)

Add a notification endpoint

Declaration
ApiResponse<NotificationEndpoint> CreateNotificationEndpointWithHttpInfo(NotificationEndpoint notificationEndpoint)
Parameters
Type Name Description
NotificationEndpoint notificationEndpoint

Notification endpoint to create

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>

ApiResponse of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsID(String, String)

Delete a notification endpoint

Declaration
void DeleteNotificationEndpointsID(string endpointID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDAsync(String, String, CancellationToken)

Delete a notification endpoint

Declaration
System.Threading.Tasks.Task DeleteNotificationEndpointsIDAsync(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task

Task of void

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>

Task of ApiResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDLabelsID(String, String, String)

Delete a label from a notification endpoint

Declaration
void DeleteNotificationEndpointsIDLabelsID(string endpointID, string labelID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a notification endpoint

Declaration
System.Threading.Tasks.Task DeleteNotificationEndpointsIDLabelsIDAsync(string endpointID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task

Task of void

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo(string endpointID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>

Task of ApiResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a notification endpoint

Declaration
ApiResponse<object> DeleteNotificationEndpointsIDLabelsIDWithHttpInfo(string endpointID, string labelID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

DeleteNotificationEndpointsIDWithHttpInfo(String, String)

Delete a notification endpoint

Declaration
ApiResponse<object> DeleteNotificationEndpointsIDWithHttpInfo(string endpointID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>

ApiResponse of Object(void)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpoints(String, String, Nullable<Int32>, Nullable<Int32>)

List all notification endpoints

Declaration
NotificationEndpoints GetNotificationEndpoints(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)
Parameters
Type Name Description
System.String orgID

Only show notification endpoints that belong to specific organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

Returns
Type Description
NotificationEndpoints

NotificationEndpoints

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List all notification endpoints

Declaration
System.Threading.Tasks.Task<NotificationEndpoints> GetNotificationEndpointsAsync(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

Only show notification endpoints that belong to specific organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<NotificationEndpoints>

Task of NotificationEndpoints

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsAsyncWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List all notification endpoints

Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoints>> GetNotificationEndpointsAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

Only show notification endpoints that belong to specific organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoints>>

Task of ApiResponse (NotificationEndpoints)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsID(String, String)

Retrieve a notification endpoint

Declaration
NotificationEndpoint GetNotificationEndpointsID(string endpointID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
NotificationEndpoint

NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDAsync(String, String, CancellationToken)

Retrieve a notification endpoint

Declaration
System.Threading.Tasks.Task<NotificationEndpoint> GetNotificationEndpointsIDAsync(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<NotificationEndpoint>

Task of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> GetNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>>

Task of ApiResponse (NotificationEndpoint)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDLabels(String, String)

List all labels for a notification endpoint

Declaration
LabelsResponse GetNotificationEndpointsIDLabels(string endpointID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
LabelsResponse

LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDLabelsAsync(String, String, CancellationToken)

List all labels for a notification endpoint

Declaration
System.Threading.Tasks.Task<LabelsResponse> GetNotificationEndpointsIDLabelsAsync(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<LabelsResponse>

Task of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetNotificationEndpointsIDLabelsAsyncWithHttpInfo(string endpointID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>>

Task of ApiResponse (LabelsResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDLabelsWithHttpInfo(String, String)

List all labels for a notification endpoint

Declaration
ApiResponse<LabelsResponse> GetNotificationEndpointsIDLabelsWithHttpInfo(string endpointID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>

ApiResponse of LabelsResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsIDWithHttpInfo(String, String)

Retrieve a notification endpoint

Declaration
ApiResponse<NotificationEndpoint> GetNotificationEndpointsIDWithHttpInfo(string endpointID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>

ApiResponse of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

GetNotificationEndpointsWithHttpInfo(String, String, Nullable<Int32>, Nullable<Int32>)

List all notification endpoints

Declaration
ApiResponse<NotificationEndpoints> GetNotificationEndpointsWithHttpInfo(string orgID, string zapTraceSpan = null, int? offset = null, int? limit = null)
Parameters
Type Name Description
System.String orgID

Only show notification endpoints that belong to specific organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoints>

ApiResponse of NotificationEndpoints

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchNotificationEndpointsID(String, NotificationEndpointUpdate, String)

Update a notification endpoint

Declaration
NotificationEndpoint PatchNotificationEndpointsID(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpointUpdate notificationEndpointUpdate

Check update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
NotificationEndpoint

NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchNotificationEndpointsIDAsync(String, NotificationEndpointUpdate, String, CancellationToken)

Update a notification endpoint

Declaration
System.Threading.Tasks.Task<NotificationEndpoint> PatchNotificationEndpointsIDAsync(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpointUpdate notificationEndpointUpdate

Check update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<NotificationEndpoint>

Task of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchNotificationEndpointsIDAsyncWithHttpInfo(String, NotificationEndpointUpdate, String, CancellationToken)

Update a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> PatchNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpointUpdate notificationEndpointUpdate

Check update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>>

Task of ApiResponse (NotificationEndpoint)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PatchNotificationEndpointsIDWithHttpInfo(String, NotificationEndpointUpdate, String)

Update a notification endpoint

Declaration
ApiResponse<NotificationEndpoint> PatchNotificationEndpointsIDWithHttpInfo(string endpointID, NotificationEndpointUpdate notificationEndpointUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpointUpdate notificationEndpointUpdate

Check update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>

ApiResponse of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostNotificationEndpointIDLabels(String, LabelMapping, String)

Add a label to a notification endpoint

Declaration
LabelResponse PostNotificationEndpointIDLabels(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
LabelResponse

LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostNotificationEndpointIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a notification endpoint

Declaration
System.Threading.Tasks.Task<LabelResponse> PostNotificationEndpointIDLabelsAsync(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<LabelResponse>

Task of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostNotificationEndpointIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostNotificationEndpointIDLabelsAsyncWithHttpInfo(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>>

Task of ApiResponse (LabelResponse)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PostNotificationEndpointIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a notification endpoint

Declaration
ApiResponse<LabelResponse> PostNotificationEndpointIDLabelsWithHttpInfo(string endpointID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

LabelMapping labelMapping

Label to add

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>

ApiResponse of LabelResponse

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PutNotificationEndpointsID(String, NotificationEndpoint, String)

Update a notification endpoint

Declaration
NotificationEndpoint PutNotificationEndpointsID(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpoint notificationEndpoint

A new notification endpoint to replace the existing endpoint with

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
NotificationEndpoint

NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PutNotificationEndpointsIDAsync(String, NotificationEndpoint, String, CancellationToken)

Update a notification endpoint

Declaration
System.Threading.Tasks.Task<NotificationEndpoint> PutNotificationEndpointsIDAsync(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpoint notificationEndpoint

A new notification endpoint to replace the existing endpoint with

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<NotificationEndpoint>

Task of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PutNotificationEndpointsIDAsyncWithHttpInfo(String, NotificationEndpoint, String, CancellationToken)

Update a notification endpoint

Declaration
System.Threading.Tasks.Task<ApiResponse<NotificationEndpoint>> PutNotificationEndpointsIDAsyncWithHttpInfo(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpoint notificationEndpoint

A new notification endpoint to replace the existing endpoint with

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>>

Task of ApiResponse (NotificationEndpoint)

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

PutNotificationEndpointsIDWithHttpInfo(String, NotificationEndpoint, String)

Update a notification endpoint

Declaration
ApiResponse<NotificationEndpoint> PutNotificationEndpointsIDWithHttpInfo(string endpointID, NotificationEndpoint notificationEndpoint, string zapTraceSpan = null)
Parameters
Type Name Description
System.String endpointID

The notification endpoint ID.

NotificationEndpoint notificationEndpoint

A new notification endpoint to replace the existing endpoint with

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<NotificationEndpoint>

ApiResponse of NotificationEndpoint

Exceptions
Type Condition
InfluxDB.Client.Api.Client.ApiException

Thrown when fails to make API call

In This Article
Back to top Generated by DocFX