• 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

Class RemoteConnectionsService

Represents a collection of functions to interact with the API endpoints

Inheritance
System.Object
RemoteConnectionsService
Implements
IRemoteConnectionsService
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class RemoteConnectionsService : object, IRemoteConnectionsService, IApiAccessor

Constructors

RemoteConnectionsService(Configuration)

Initializes a new instance of the RemoteConnectionsService class using Configuration object

Declaration
public RemoteConnectionsService(Configuration configuration = null)
Parameters
Type Name Description
InfluxDB.Client.Api.Client.Configuration configuration

An instance of Configuration

RemoteConnectionsService(String)

Initializes a new instance of the RemoteConnectionsService class.

Declaration
public RemoteConnectionsService(string basePath)
Parameters
Type Name Description
System.String basePath

Properties

Configuration

Gets or sets the configuration object

Declaration
public Configuration Configuration { get; set; }
Property Value
Type Description
InfluxDB.Client.Api.Client.Configuration

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration
public void AddDefaultHeader(string key, string value)
Parameters
Type Name Description
System.String key

Header field name.

System.String value

Header field value.

DefaultHeader()

Gets the default header.

Declaration
public IDictionary<string, string> DefaultHeader()
Returns
Type Description
IDictionary<System.String, System.String>

Dictionary of HTTP header

DeleteRemoteConnectionByID(String, String)

Delete a remote connection

Declaration
public void DeleteRemoteConnectionByID(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteRemoteConnectionByIDAsync(String, String, CancellationToken)

Delete a remote connection

Declaration
public System.Threading.Tasks.Task DeleteRemoteConnectionByIDAsync(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
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

DeleteRemoteConnectionByIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a remote connection

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteRemoteConnectionByIDAsyncWithHttpInfo(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
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

DeleteRemoteConnectionByIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteRemoteConnectionByIDAsyncWithIRestResponse(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse

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

Thrown when fails to make API call

DeleteRemoteConnectionByIDWithHttpInfo(String, String)

Delete a remote connection

Declaration
public ApiResponse<object> DeleteRemoteConnectionByIDWithHttpInfo(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
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

DeleteRemoteConnectionByIDWithIRestResponse(String, String)

Delete a remote connection

Declaration
public RestResponse DeleteRemoteConnectionByIDWithIRestResponse(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteRemoteConnectionByIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteRemoteConnectionByIDWithIRestResponseAsync(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteRemoteConnectionByIDWithRestRequest(String, String)

Delete a remote connection

Declaration
public RestRequest DeleteRemoteConnectionByIDWithRestRequest(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

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

Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
System.String

The base path

GetRemoteConnectionByID(String, String)

Retrieve a remote connection

Declaration
public RemoteConnection GetRemoteConnectionByID(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RemoteConnection

RemoteConnection

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

Thrown when fails to make API call

GetRemoteConnectionByIDAsync(String, String, CancellationToken)

Retrieve a remote connection

Declaration
public async System.Threading.Tasks.Task<RemoteConnection> GetRemoteConnectionByIDAsync(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RemoteConnection

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

Thrown when fails to make API call

GetRemoteConnectionByIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a remote connection

Declaration
public async System.Threading.Tasks.Task<ApiResponse<RemoteConnection>> GetRemoteConnectionByIDAsyncWithHttpInfo(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (RemoteConnection)

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

Thrown when fails to make API call

GetRemoteConnectionByIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetRemoteConnectionByIDAsyncWithIRestResponse(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (RemoteConnection)

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

Thrown when fails to make API call

GetRemoteConnectionByIDWithHttpInfo(String, String)

Retrieve a remote connection

Declaration
public ApiResponse<RemoteConnection> GetRemoteConnectionByIDWithHttpInfo(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

GetRemoteConnectionByIDWithIRestResponse(String, String)

Retrieve a remote connection

Declaration
public RestResponse GetRemoteConnectionByIDWithIRestResponse(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

GetRemoteConnectionByIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetRemoteConnectionByIDWithIRestResponseAsync(string remoteID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

GetRemoteConnectionByIDWithRestRequest(String, String)

Retrieve a remote connection

Declaration
public RestRequest GetRemoteConnectionByIDWithRestRequest(string remoteID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

GetRemoteConnections(String, String, String, String)

List all remote connections

Declaration
public RemoteConnections GetRemoteConnections(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

Returns
Type Description
RemoteConnections

RemoteConnections

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

Thrown when fails to make API call

GetRemoteConnectionsAsync(String, String, String, String, CancellationToken)

List all remote connections

Declaration
public async System.Threading.Tasks.Task<RemoteConnections> GetRemoteConnectionsAsync(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RemoteConnections

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

Thrown when fails to make API call

GetRemoteConnectionsAsyncWithHttpInfo(String, String, String, String, CancellationToken)

List all remote connections

Declaration
public async System.Threading.Tasks.Task<ApiResponse<RemoteConnections>> GetRemoteConnectionsAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (RemoteConnections)

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

Thrown when fails to make API call

GetRemoteConnectionsAsyncWithIRestResponse(String, String, String, String, CancellationToken)

List all remote connections

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetRemoteConnectionsAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (RemoteConnections)

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

Thrown when fails to make API call

GetRemoteConnectionsWithHttpInfo(String, String, String, String)

List all remote connections

Declaration
public ApiResponse<RemoteConnections> GetRemoteConnectionsWithHttpInfo(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

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

ApiResponse of RemoteConnections

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

Thrown when fails to make API call

GetRemoteConnectionsWithIRestResponse(String, String, String, String)

List all remote connections

Declaration
public RestResponse GetRemoteConnectionsWithIRestResponse(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

Returns
Type Description
RestResponse

ApiResponse of RemoteConnections

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

Thrown when fails to make API call

GetRemoteConnectionsWithIRestResponseAsync(String, String, String, String, CancellationToken)

List all remote connections

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetRemoteConnectionsWithIRestResponseAsync(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of RemoteConnections

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

Thrown when fails to make API call

GetRemoteConnectionsWithRestRequest(String, String, String, String)

List all remote connections

Declaration
public RestRequest GetRemoteConnectionsWithRestRequest(string orgID, string zapTraceSpan = null, string name = null, string remoteURL = null)
Parameters
Type Name Description
System.String orgID

The organization ID.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String name

(optional)

System.String remoteURL

(optional)

Returns
Type Description
RestRequest

ApiResponse of RemoteConnections

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

Thrown when fails to make API call

PatchRemoteConnectionByID(String, RemoteConnectionUpdateRequest, String)

Update a remote connection

Declaration
public RemoteConnection PatchRemoteConnectionByID(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RemoteConnection

RemoteConnection

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

Thrown when fails to make API call

PatchRemoteConnectionByIDAsync(String, RemoteConnectionUpdateRequest, String, CancellationToken)

Update a remote connection

Declaration
public async System.Threading.Tasks.Task<RemoteConnection> PatchRemoteConnectionByIDAsync(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RemoteConnection

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

Thrown when fails to make API call

PatchRemoteConnectionByIDAsyncWithHttpInfo(String, RemoteConnectionUpdateRequest, String, CancellationToken)

Update a remote connection

Declaration
public async System.Threading.Tasks.Task<ApiResponse<RemoteConnection>> PatchRemoteConnectionByIDAsyncWithHttpInfo(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (RemoteConnection)

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

Thrown when fails to make API call

PatchRemoteConnectionByIDAsyncWithIRestResponse(String, RemoteConnectionUpdateRequest, String, CancellationToken)

Update a remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchRemoteConnectionByIDAsyncWithIRestResponse(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (RemoteConnection)

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

Thrown when fails to make API call

PatchRemoteConnectionByIDWithHttpInfo(String, RemoteConnectionUpdateRequest, String)

Update a remote connection

Declaration
public ApiResponse<RemoteConnection> PatchRemoteConnectionByIDWithHttpInfo(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PatchRemoteConnectionByIDWithIRestResponse(String, RemoteConnectionUpdateRequest, String)

Update a remote connection

Declaration
public RestResponse PatchRemoteConnectionByIDWithIRestResponse(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PatchRemoteConnectionByIDWithIRestResponseAsync(String, RemoteConnectionUpdateRequest, String, CancellationToken)

Update a remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchRemoteConnectionByIDWithIRestResponseAsync(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PatchRemoteConnectionByIDWithRestRequest(String, RemoteConnectionUpdateRequest, String)

Update a remote connection

Declaration
public RestRequest PatchRemoteConnectionByIDWithRestRequest(string remoteID, RemoteConnectionUpdateRequest remoteConnectionUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String remoteID
RemoteConnectionUpdateRequest remoteConnectionUpdateRequest
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PostRemoteConnection(RemoteConnectionCreationRequest)

Register a new remote connection

Declaration
public RemoteConnection PostRemoteConnection(RemoteConnectionCreationRequest remoteConnectionCreationRequest)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
Returns
Type Description
RemoteConnection

RemoteConnection

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

Thrown when fails to make API call

PostRemoteConnectionAsync(RemoteConnectionCreationRequest, CancellationToken)

Register a new remote connection

Declaration
public async System.Threading.Tasks.Task<RemoteConnection> PostRemoteConnectionAsync(RemoteConnectionCreationRequest remoteConnectionCreationRequest, CancellationToken cancellationToken = null)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
CancellationToken cancellationToken

Cancellation token

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

Task of RemoteConnection

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

Thrown when fails to make API call

PostRemoteConnectionAsyncWithHttpInfo(RemoteConnectionCreationRequest, CancellationToken)

Register a new remote connection

Declaration
public async System.Threading.Tasks.Task<ApiResponse<RemoteConnection>> PostRemoteConnectionAsyncWithHttpInfo(RemoteConnectionCreationRequest remoteConnectionCreationRequest, CancellationToken cancellationToken = null)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (RemoteConnection)

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

Thrown when fails to make API call

PostRemoteConnectionAsyncWithIRestResponse(RemoteConnectionCreationRequest, CancellationToken)

Register a new remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostRemoteConnectionAsyncWithIRestResponse(RemoteConnectionCreationRequest remoteConnectionCreationRequest, CancellationToken cancellationToken = null)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (RemoteConnection)

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

Thrown when fails to make API call

PostRemoteConnectionWithHttpInfo(RemoteConnectionCreationRequest)

Register a new remote connection

Declaration
public ApiResponse<RemoteConnection> PostRemoteConnectionWithHttpInfo(RemoteConnectionCreationRequest remoteConnectionCreationRequest)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<RemoteConnection>

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PostRemoteConnectionWithIRestResponse(RemoteConnectionCreationRequest)

Register a new remote connection

Declaration
public RestResponse PostRemoteConnectionWithIRestResponse(RemoteConnectionCreationRequest remoteConnectionCreationRequest)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
Returns
Type Description
RestResponse

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PostRemoteConnectionWithIRestResponseAsync(RemoteConnectionCreationRequest, CancellationToken)

Register a new remote connection

Declaration
public async System.Threading.Tasks.Task<RestResponse> PostRemoteConnectionWithIRestResponseAsync(RemoteConnectionCreationRequest remoteConnectionCreationRequest, CancellationToken cancellationToken = null)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
CancellationToken cancellationToken

Cancellation token

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

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

PostRemoteConnectionWithRestRequest(RemoteConnectionCreationRequest)

Register a new remote connection

Declaration
public RestRequest PostRemoteConnectionWithRestRequest(RemoteConnectionCreationRequest remoteConnectionCreationRequest)
Parameters
Type Name Description
RemoteConnectionCreationRequest remoteConnectionCreationRequest
Returns
Type Description
RestRequest

ApiResponse of RemoteConnection

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

Thrown when fails to make API call

SetBasePath(String)

Sets the base path of the API client.

Declaration
public void SetBasePath(string basePath)
Parameters
Type Name Description
System.String basePath

Implements

IRemoteConnectionsService
In This Article
Back to top Generated by DocFX