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

Represents a collection of functions to interact with the API endpoints

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

Methods

ApplyTemplate(TemplateApply)

Apply or dry-run a template

Declaration
TemplateSummary ApplyTemplate(TemplateApply templateApply)
Parameters
Type Name Description
TemplateApply templateApply
Returns
Type Description
TemplateSummary

TemplateSummary

Remarks

Applies or performs a dry-run of template in an organization.

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

Thrown when fails to make API call

ApplyTemplateAsync(TemplateApply, CancellationToken)

Apply or dry-run a template

Declaration
System.Threading.Tasks.Task<TemplateSummary> ApplyTemplateAsync(TemplateApply templateApply, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TemplateApply templateApply
CancellationToken cancellationToken

Cancellation token

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

Task of TemplateSummary

Remarks

Applies or performs a dry-run of template in an organization.

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

Thrown when fails to make API call

ApplyTemplateAsyncWithHttpInfo(TemplateApply, CancellationToken)

Apply or dry-run a template

Declaration
System.Threading.Tasks.Task<ApiResponse<TemplateSummary>> ApplyTemplateAsyncWithHttpInfo(TemplateApply templateApply, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TemplateApply templateApply
CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (TemplateSummary)

Remarks

Applies or performs a dry-run of template in an organization.

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

Thrown when fails to make API call

ApplyTemplateWithHttpInfo(TemplateApply)

Apply or dry-run a template

Declaration
ApiResponse<TemplateSummary> ApplyTemplateWithHttpInfo(TemplateApply templateApply)
Parameters
Type Name Description
TemplateApply templateApply
Returns
Type Description
InfluxDB.Client.Api.Client.ApiResponse<TemplateSummary>

ApiResponse of TemplateSummary

Remarks

Applies or performs a dry-run of template in an organization.

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

Thrown when fails to make API call

CreateStack(PostStackRequest)

Create a new stack

Declaration
Stack CreateStack(PostStackRequest postStackRequest = null)
Parameters
Type Name Description
PostStackRequest postStackRequest

(optional)

Returns
Type Description
Stack

Stack

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

Thrown when fails to make API call

CreateStackAsync(PostStackRequest, CancellationToken)

Create a new stack

Declaration
System.Threading.Tasks.Task<Stack> CreateStackAsync(PostStackRequest postStackRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
PostStackRequest postStackRequest

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Stack

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

Thrown when fails to make API call

CreateStackAsyncWithHttpInfo(PostStackRequest, CancellationToken)

Create a new stack

Declaration
System.Threading.Tasks.Task<ApiResponse<Stack>> CreateStackAsyncWithHttpInfo(PostStackRequest postStackRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
PostStackRequest postStackRequest

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Stack)

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

Thrown when fails to make API call

CreateStackWithHttpInfo(PostStackRequest)

Create a new stack

Declaration
ApiResponse<Stack> CreateStackWithHttpInfo(PostStackRequest postStackRequest = null)
Parameters
Type Name Description
PostStackRequest postStackRequest

(optional)

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

ApiResponse of Stack

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

Thrown when fails to make API call

DeleteStack(String, String)

Delete a stack and associated resources

Declaration
void DeleteStack(string stackId, string orgID)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

System.String orgID

The identifier of the organization.

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

Thrown when fails to make API call

DeleteStackAsync(String, String, CancellationToken)

Delete a stack and associated resources

Declaration
System.Threading.Tasks.Task DeleteStackAsync(string stackId, string orgID, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

System.String orgID

The identifier of the organization.

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

DeleteStackAsyncWithHttpInfo(String, String, CancellationToken)

Delete a stack and associated resources

Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteStackAsyncWithHttpInfo(string stackId, string orgID, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

System.String orgID

The identifier of the organization.

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

DeleteStackWithHttpInfo(String, String)

Delete a stack and associated resources

Declaration
ApiResponse<object> DeleteStackWithHttpInfo(string stackId, string orgID)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

System.String orgID

The identifier of the organization.

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

ExportTemplate(TemplateExportByID)

Export a new template

Declaration
List<object> ExportTemplate(TemplateExportByID templateExportByID = null)
Parameters
Type Name Description
TemplateExportByID templateExportByID

Export resources as an InfluxDB template. (optional)

Returns
Type Description
List<System.Object>

List<Object>

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

Thrown when fails to make API call

ExportTemplateAsync(TemplateExportByID, CancellationToken)

Export a new template

Declaration
System.Threading.Tasks.Task<List<object>> ExportTemplateAsync(TemplateExportByID templateExportByID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TemplateExportByID templateExportByID

Export resources as an InfluxDB template. (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task<List<System.Object>>

Task of List<Object>

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

Thrown when fails to make API call

ExportTemplateAsyncWithHttpInfo(TemplateExportByID, CancellationToken)

Export a new template

Declaration
System.Threading.Tasks.Task<ApiResponse<List<object>>> ExportTemplateAsyncWithHttpInfo(TemplateExportByID templateExportByID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TemplateExportByID templateExportByID

Export resources as an InfluxDB template. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (List<Object>)

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

Thrown when fails to make API call

ExportTemplateWithHttpInfo(TemplateExportByID)

Export a new template

Declaration
ApiResponse<List<object>> ExportTemplateWithHttpInfo(TemplateExportByID templateExportByID = null)
Parameters
Type Name Description
TemplateExportByID templateExportByID

Export resources as an InfluxDB template. (optional)

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

ApiResponse of List<Object>

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

Thrown when fails to make API call

ListStacks(String, String, String)

List installed templates

Declaration
ListStacksResponse ListStacks(string orgID, string name = null, string stackID = null)
Parameters
Type Name Description
System.String orgID

The organization ID of the stacks

System.String name

A collection of names to filter the list by. (optional)

System.String stackID

A collection of stackIDs to filter the list by. (optional)

Returns
Type Description
ListStacksResponse

ListStacksResponse

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

Thrown when fails to make API call

ListStacksAsync(String, String, String, CancellationToken)

List installed templates

Declaration
System.Threading.Tasks.Task<ListStacksResponse> ListStacksAsync(string orgID, string name = null, string stackID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID of the stacks

System.String name

A collection of names to filter the list by. (optional)

System.String stackID

A collection of stackIDs to filter the list by. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ListStacksResponse

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

Thrown when fails to make API call

ListStacksAsyncWithHttpInfo(String, String, String, CancellationToken)

List installed templates

Declaration
System.Threading.Tasks.Task<ApiResponse<ListStacksResponse>> ListStacksAsyncWithHttpInfo(string orgID, string name = null, string stackID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgID

The organization ID of the stacks

System.String name

A collection of names to filter the list by. (optional)

System.String stackID

A collection of stackIDs to filter the list by. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (ListStacksResponse)

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

Thrown when fails to make API call

ListStacksWithHttpInfo(String, String, String)

List installed templates

Declaration
ApiResponse<ListStacksResponse> ListStacksWithHttpInfo(string orgID, string name = null, string stackID = null)
Parameters
Type Name Description
System.String orgID

The organization ID of the stacks

System.String name

A collection of names to filter the list by. (optional)

System.String stackID

A collection of stackIDs to filter the list by. (optional)

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

ApiResponse of ListStacksResponse

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

Thrown when fails to make API call

ReadStack(String)

Retrieve a stack

Declaration
Stack ReadStack(string stackId)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

Returns
Type Description
Stack

Stack

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

Thrown when fails to make API call

ReadStackAsync(String, CancellationToken)

Retrieve a stack

Declaration
System.Threading.Tasks.Task<Stack> ReadStackAsync(string stackId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

CancellationToken cancellationToken

Cancellation token

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

Task of Stack

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

Thrown when fails to make API call

ReadStackAsyncWithHttpInfo(String, CancellationToken)

Retrieve a stack

Declaration
System.Threading.Tasks.Task<ApiResponse<Stack>> ReadStackAsyncWithHttpInfo(string stackId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Stack)

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

Thrown when fails to make API call

ReadStackWithHttpInfo(String)

Retrieve a stack

Declaration
ApiResponse<Stack> ReadStackWithHttpInfo(string stackId)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

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

ApiResponse of Stack

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

Thrown when fails to make API call

UninstallStack(String)

Uninstall a stack

Declaration
Stack UninstallStack(string stackId)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

Returns
Type Description
Stack

Stack

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

Thrown when fails to make API call

UninstallStackAsync(String, CancellationToken)

Uninstall a stack

Declaration
System.Threading.Tasks.Task<Stack> UninstallStackAsync(string stackId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

CancellationToken cancellationToken

Cancellation token

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

Task of Stack

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

Thrown when fails to make API call

UninstallStackAsyncWithHttpInfo(String, CancellationToken)

Uninstall a stack

Declaration
System.Threading.Tasks.Task<ApiResponse<Stack>> UninstallStackAsyncWithHttpInfo(string stackId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Stack)

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

Thrown when fails to make API call

UninstallStackWithHttpInfo(String)

Uninstall a stack

Declaration
ApiResponse<Stack> UninstallStackWithHttpInfo(string stackId)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

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

ApiResponse of Stack

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

Thrown when fails to make API call

UpdateStack(String, PatchStackRequest)

Update a stack

Declaration
Stack UpdateStack(string stackId, PatchStackRequest patchStackRequest = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

PatchStackRequest patchStackRequest

(optional)

Returns
Type Description
Stack

Stack

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

Thrown when fails to make API call

UpdateStackAsync(String, PatchStackRequest, CancellationToken)

Update a stack

Declaration
System.Threading.Tasks.Task<Stack> UpdateStackAsync(string stackId, PatchStackRequest patchStackRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

PatchStackRequest patchStackRequest

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Stack

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

Thrown when fails to make API call

UpdateStackAsyncWithHttpInfo(String, PatchStackRequest, CancellationToken)

Update a stack

Declaration
System.Threading.Tasks.Task<ApiResponse<Stack>> UpdateStackAsyncWithHttpInfo(string stackId, PatchStackRequest patchStackRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

PatchStackRequest patchStackRequest

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Stack)

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

Thrown when fails to make API call

UpdateStackWithHttpInfo(String, PatchStackRequest)

Update a stack

Declaration
ApiResponse<Stack> UpdateStackWithHttpInfo(string stackId, PatchStackRequest patchStackRequest = null)
Parameters
Type Name Description
System.String stackId

The identifier of the stack.

PatchStackRequest patchStackRequest

(optional)

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

ApiResponse of Stack

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

Thrown when fails to make API call

In This Article
Back to top Generated by DocFX