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

Represents a collection of functions to interact with the API endpoints

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

Methods

DeleteTelegrafsID(String, String)

Delete a Telegraf configuration

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

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteTelegrafsIDAsync(String, String, CancellationToken)

Delete a Telegraf configuration

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

The Telegraf configuration 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

DeleteTelegrafsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a Telegraf configuration

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

The Telegraf configuration 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

DeleteTelegrafsIDLabelsID(String, String, String)

Delete a label from a Telegraf config

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

The Telegraf config ID.

System.String labelID

The label ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteTelegrafsIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a Telegraf config

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

The Telegraf config ID.

System.String labelID

The label 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

DeleteTelegrafsIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a Telegraf config

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

The Telegraf config ID.

System.String labelID

The label 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

DeleteTelegrafsIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a Telegraf config

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

The Telegraf config ID.

System.String labelID

The label 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

DeleteTelegrafsIDMembersID(String, String, String)

Remove a member from a Telegraf config

Declaration
void DeleteTelegrafsIDMembersID(string userID, string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String telegrafID

The Telegraf config ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteTelegrafsIDMembersIDAsync(String, String, String, CancellationToken)

Remove a member from a Telegraf config

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

The ID of the member to remove.

System.String telegrafID

The Telegraf config 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

DeleteTelegrafsIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove a member from a Telegraf config

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

The ID of the member to remove.

System.String telegrafID

The Telegraf config 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

DeleteTelegrafsIDMembersIDWithHttpInfo(String, String, String)

Remove a member from a Telegraf config

Declaration
ApiResponse<object> DeleteTelegrafsIDMembersIDWithHttpInfo(string userID, string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the member to remove.

System.String telegrafID

The Telegraf config 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

DeleteTelegrafsIDOwnersID(String, String, String)

Remove an owner from a Telegraf config

Declaration
void DeleteTelegrafsIDOwnersID(string userID, string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String telegrafID

The Telegraf config ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteTelegrafsIDOwnersIDAsync(String, String, String, CancellationToken)

Remove an owner from a Telegraf config

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

The ID of the owner to remove.

System.String telegrafID

The Telegraf config 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

DeleteTelegrafsIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove an owner from a Telegraf config

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

The ID of the owner to remove.

System.String telegrafID

The Telegraf config 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

DeleteTelegrafsIDOwnersIDWithHttpInfo(String, String, String)

Remove an owner from a Telegraf config

Declaration
ApiResponse<object> DeleteTelegrafsIDOwnersIDWithHttpInfo(string userID, string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String userID

The ID of the owner to remove.

System.String telegrafID

The Telegraf config 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

DeleteTelegrafsIDWithHttpInfo(String, String)

Delete a Telegraf configuration

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

The Telegraf configuration 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

GetTelegrafs(String, String)

List all Telegraf configurations

Declaration
Telegrafs GetTelegrafs(string zapTraceSpan = null, string orgID = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String orgID

The organization ID the Telegraf config belongs to. (optional)

Returns
Type Description
Telegrafs

Telegrafs

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

Thrown when fails to make API call

GetTelegrafsAsync(String, String, CancellationToken)

List all Telegraf configurations

Declaration
System.Threading.Tasks.Task<Telegrafs> GetTelegrafsAsync(string zapTraceSpan = null, string orgID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String orgID

The organization ID the Telegraf config belongs to. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Telegrafs

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

Thrown when fails to make API call

GetTelegrafsAsyncWithHttpInfo(String, String, CancellationToken)

List all Telegraf configurations

Declaration
System.Threading.Tasks.Task<ApiResponse<Telegrafs>> GetTelegrafsAsyncWithHttpInfo(string zapTraceSpan = null, string orgID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String orgID

The organization ID the Telegraf config belongs to. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Telegrafs)

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

Thrown when fails to make API call

GetTelegrafsID(String, String, String)

Retrieve a Telegraf configuration

Declaration
string GetTelegrafsID(string telegrafID, string zapTraceSpan = null, string accept = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String accept

(optional, default to application/toml)

Returns
Type Description
System.String

string

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

Thrown when fails to make API call

GetTelegrafsIDAsync(String, String, String, CancellationToken)

Retrieve a Telegraf configuration

Declaration
System.Threading.Tasks.Task<string> GetTelegrafsIDAsync(string telegrafID, string zapTraceSpan = null, string accept = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String accept

(optional, default to application/toml)

CancellationToken cancellationToken

Cancellation token

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

Task of string

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

Thrown when fails to make API call

GetTelegrafsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ApiResponse<string>> GetTelegrafsIDAsyncWithHttpInfo(string telegrafID, string zapTraceSpan = null, string accept = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String accept

(optional, default to application/toml)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (string)

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

Thrown when fails to make API call

GetTelegrafsIDLabels(String, String)

List all labels for a Telegraf config

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

The Telegraf config 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

GetTelegrafsIDLabelsAsync(String, String, CancellationToken)

List all labels for a Telegraf config

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

The Telegraf config 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

GetTelegrafsIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a Telegraf config

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

The Telegraf config 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

GetTelegrafsIDLabelsWithHttpInfo(String, String)

List all labels for a Telegraf config

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

The Telegraf config 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

GetTelegrafsIDMembers(String, String)

List all users with member privileges for a Telegraf config

Declaration
ResourceMembers GetTelegrafsIDMembers(string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceMembers

ResourceMembers

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

Thrown when fails to make API call

GetTelegrafsIDMembersAsync(String, String, CancellationToken)

List all users with member privileges for a Telegraf config

Declaration
System.Threading.Tasks.Task<ResourceMembers> GetTelegrafsIDMembersAsync(string telegrafID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ResourceMembers

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

Thrown when fails to make API call

GetTelegrafsIDMembersAsyncWithHttpInfo(String, String, CancellationToken)

List all users with member privileges for a Telegraf config

Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetTelegrafsIDMembersAsyncWithHttpInfo(string telegrafID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (ResourceMembers)

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

Thrown when fails to make API call

GetTelegrafsIDMembersWithHttpInfo(String, String)

List all users with member privileges for a Telegraf config

Declaration
ApiResponse<ResourceMembers> GetTelegrafsIDMembersWithHttpInfo(string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of ResourceMembers

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

Thrown when fails to make API call

GetTelegrafsIDOwners(String, String)

List all owners of a Telegraf configuration

Declaration
ResourceOwners GetTelegrafsIDOwners(string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceOwners

ResourceOwners

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

Thrown when fails to make API call

GetTelegrafsIDOwnersAsync(String, String, CancellationToken)

List all owners of a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ResourceOwners> GetTelegrafsIDOwnersAsync(string telegrafID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ResourceOwners

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

Thrown when fails to make API call

GetTelegrafsIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)

List all owners of a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetTelegrafsIDOwnersAsyncWithHttpInfo(string telegrafID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (ResourceOwners)

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

Thrown when fails to make API call

GetTelegrafsIDOwnersWithHttpInfo(String, String)

List all owners of a Telegraf configuration

Declaration
ApiResponse<ResourceOwners> GetTelegrafsIDOwnersWithHttpInfo(string telegrafID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of ResourceOwners

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

Thrown when fails to make API call

GetTelegrafsIDWithHttpInfo(String, String, String)

Retrieve a Telegraf configuration

Declaration
ApiResponse<string> GetTelegrafsIDWithHttpInfo(string telegrafID, string zapTraceSpan = null, string accept = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String accept

(optional, default to application/toml)

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

ApiResponse of string

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

Thrown when fails to make API call

GetTelegrafsWithHttpInfo(String, String)

List all Telegraf configurations

Declaration
ApiResponse<Telegrafs> GetTelegrafsWithHttpInfo(string zapTraceSpan = null, string orgID = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String orgID

The organization ID the Telegraf config belongs to. (optional)

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

ApiResponse of Telegrafs

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

Thrown when fails to make API call

PostTelegrafs(TelegrafPluginRequest, String)

Create a Telegraf configuration

Declaration
Telegraf PostTelegrafs(TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null)
Parameters
Type Name Description
TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Telegraf

Telegraf

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

Thrown when fails to make API call

PostTelegrafsAsync(TelegrafPluginRequest, String, CancellationToken)

Create a Telegraf configuration

Declaration
System.Threading.Tasks.Task<Telegraf> PostTelegrafsAsync(TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Telegraf

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

Thrown when fails to make API call

PostTelegrafsAsyncWithHttpInfo(TelegrafPluginRequest, String, CancellationToken)

Create a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ApiResponse<Telegraf>> PostTelegrafsAsyncWithHttpInfo(TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Telegraf)

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

Thrown when fails to make API call

PostTelegrafsIDLabels(String, LabelMapping, String)

Add a label to a Telegraf config

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

The Telegraf config 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

PostTelegrafsIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a Telegraf config

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

The Telegraf config 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

PostTelegrafsIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a Telegraf config

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

The Telegraf config 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

PostTelegrafsIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a Telegraf config

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

The Telegraf config 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

PostTelegrafsIDMembers(String, AddResourceMemberRequestBody, String)

Add a member to a Telegraf config

Declaration
ResourceMember PostTelegrafsIDMembers(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceMember

ResourceMember

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

Thrown when fails to make API call

PostTelegrafsIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a Telegraf config

Declaration
System.Threading.Tasks.Task<ResourceMember> PostTelegrafsIDMembersAsync(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ResourceMember

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

Thrown when fails to make API call

PostTelegrafsIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a Telegraf config

Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostTelegrafsIDMembersAsyncWithHttpInfo(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (ResourceMember)

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

Thrown when fails to make API call

PostTelegrafsIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add a member to a Telegraf config

Declaration
ApiResponse<ResourceMember> PostTelegrafsIDMembersWithHttpInfo(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as member

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of ResourceMember

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

Thrown when fails to make API call

PostTelegrafsIDOwners(String, AddResourceMemberRequestBody, String)

Add an owner to a Telegraf configuration

Declaration
ResourceOwner PostTelegrafsIDOwners(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
ResourceOwner

ResourceOwner

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

Thrown when fails to make API call

PostTelegrafsIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ResourceOwner> PostTelegrafsIDOwnersAsync(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ResourceOwner

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

Thrown when fails to make API call

PostTelegrafsIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostTelegrafsIDOwnersAsyncWithHttpInfo(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (ResourceOwner)

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

Thrown when fails to make API call

PostTelegrafsIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add an owner to a Telegraf configuration

Declaration
ApiResponse<ResourceOwner> PostTelegrafsIDOwnersWithHttpInfo(string telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf configuration ID.

AddResourceMemberRequestBody addResourceMemberRequestBody

User to add as owner

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of ResourceOwner

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

Thrown when fails to make API call

PostTelegrafsWithHttpInfo(TelegrafPluginRequest, String)

Create a Telegraf configuration

Declaration
ApiResponse<Telegraf> PostTelegrafsWithHttpInfo(TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null)
Parameters
Type Name Description
TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration to create

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Telegraf

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

Thrown when fails to make API call

PutTelegrafsID(String, TelegrafPluginRequest, String)

Update a Telegraf configuration

Declaration
Telegraf PutTelegrafsID(string telegrafID, TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Telegraf

Telegraf

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

Thrown when fails to make API call

PutTelegrafsIDAsync(String, TelegrafPluginRequest, String, CancellationToken)

Update a Telegraf configuration

Declaration
System.Threading.Tasks.Task<Telegraf> PutTelegrafsIDAsync(string telegrafID, TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Telegraf

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

Thrown when fails to make API call

PutTelegrafsIDAsyncWithHttpInfo(String, TelegrafPluginRequest, String, CancellationToken)

Update a Telegraf configuration

Declaration
System.Threading.Tasks.Task<ApiResponse<Telegraf>> PutTelegrafsIDAsyncWithHttpInfo(string telegrafID, TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

TelegrafPluginRequest telegrafPluginRequest

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

Task of ApiResponse (Telegraf)

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

Thrown when fails to make API call

PutTelegrafsIDWithHttpInfo(String, TelegrafPluginRequest, String)

Update a Telegraf configuration

Declaration
ApiResponse<Telegraf> PutTelegrafsIDWithHttpInfo(string telegrafID, TelegrafPluginRequest telegrafPluginRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String telegrafID

The Telegraf config ID.

TelegrafPluginRequest telegrafPluginRequest

Telegraf configuration update to apply

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Telegraf

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

Thrown when fails to make API call

In This Article
Back to top Generated by DocFX