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

Represents a collection of functions to interact with the API endpoints

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

Methods

DeleteDashboardsID(String, String)

Delete a dashboard

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

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteDashboardsIDAsync(String, String, CancellationToken)

Delete a dashboard

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

The ID of the dashboard to update.

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

DeleteDashboardsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a dashboard

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

The ID of the dashboard to update.

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

DeleteDashboardsIDCellsID(String, String, String)

Delete a dashboard cell

Declaration
void DeleteDashboardsIDCellsID(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to delete.

System.String cellID

The ID of the cell to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteDashboardsIDCellsIDAsync(String, String, String, CancellationToken)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task

Task of void

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

Thrown when fails to make API call

DeleteDashboardsIDCellsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a dashboard cell

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

The ID of the dashboard to delete.

System.String cellID

The ID of the cell to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse

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

Thrown when fails to make API call

DeleteDashboardsIDCellsIDWithHttpInfo(String, String, String)

Delete a dashboard cell

Declaration
ApiResponse<object> DeleteDashboardsIDCellsIDWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to delete.

System.String cellID

The ID of the cell to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteDashboardsIDLabelsID(String, String, String)

Delete a label from a dashboard

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

The dashboard ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteDashboardsIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a dashboard

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

The dashboard ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
System.Threading.Tasks.Task

Task of void

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

Thrown when fails to make API call

DeleteDashboardsIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a dashboard

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

The dashboard ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse

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

Thrown when fails to make API call

DeleteDashboardsIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a dashboard

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

The dashboard ID.

System.String labelID

The ID of the label to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteDashboardsIDMembersID(String, String, String)

Remove a member from a dashboard

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

The ID of the member to remove.

System.String dashboardID

The dashboard ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteDashboardsIDMembersIDAsync(String, String, String, CancellationToken)

Remove a member from a dashboard

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

The ID of the member to remove.

System.String dashboardID

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

DeleteDashboardsIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove a member from a dashboard

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

The ID of the member to remove.

System.String dashboardID

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

DeleteDashboardsIDMembersIDWithHttpInfo(String, String, String)

Remove a member from a dashboard

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

The ID of the member to remove.

System.String dashboardID

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

DeleteDashboardsIDOwnersID(String, String, String)

Remove an owner from a dashboard

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

The ID of the owner to remove.

System.String dashboardID

The dashboard ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteDashboardsIDOwnersIDAsync(String, String, String, CancellationToken)

Remove an owner from a dashboard

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

The ID of the owner to remove.

System.String dashboardID

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

DeleteDashboardsIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove an owner from a dashboard

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

The ID of the owner to remove.

System.String dashboardID

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

DeleteDashboardsIDOwnersIDWithHttpInfo(String, String, String)

Remove an owner from a dashboard

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

The ID of the owner to remove.

System.String dashboardID

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

DeleteDashboardsIDWithHttpInfo(String, String)

Delete a dashboard

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

The ID of the dashboard to update.

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

GetDashboards(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, List<String>, String, String)

List all dashboards

Declaration
Dashboards GetDashboards(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string owner = null, string sortBy = null, List<string> id = null, string orgID = null, string org = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

System.Nullable<System.Boolean> descending

(optional, default to false)

System.String owner

A user identifier. Returns only dashboards where this user has the owner role. (optional)

System.String sortBy

The column to sort by. (optional)

List<System.String> id

A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used. (optional)

System.String orgID

The identifier of the organization. (optional)

System.String org

The name of the organization. (optional)

Returns
Type Description
Dashboards

Dashboards

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

Thrown when fails to make API call

GetDashboardsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, List<String>, String, String, CancellationToken)

List all dashboards

Declaration
System.Threading.Tasks.Task<Dashboards> GetDashboardsAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string owner = null, string sortBy = null, List<string> id = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

System.Nullable<System.Boolean> descending

(optional, default to false)

System.String owner

A user identifier. Returns only dashboards where this user has the owner role. (optional)

System.String sortBy

The column to sort by. (optional)

List<System.String> id

A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used. (optional)

System.String orgID

The identifier of the organization. (optional)

System.String org

The name of the organization. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Dashboards

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

Thrown when fails to make API call

GetDashboardsAsyncWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, List<String>, String, String, CancellationToken)

List all dashboards

Declaration
System.Threading.Tasks.Task<ApiResponse<Dashboards>> GetDashboardsAsyncWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string owner = null, string sortBy = null, List<string> id = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

System.Nullable<System.Boolean> descending

(optional, default to false)

System.String owner

A user identifier. Returns only dashboards where this user has the owner role. (optional)

System.String sortBy

The column to sort by. (optional)

List<System.String> id

A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used. (optional)

System.String orgID

The identifier of the organization. (optional)

System.String org

The name of the organization. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Dashboards)

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

Thrown when fails to make API call

GetDashboardsID(String, String, String)

Retrieve a Dashboard

Declaration
Dashboard GetDashboardsID(string dashboardID, string zapTraceSpan = null, string include = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String include

Includes the cell view properties in the response if set to properties (optional)

Returns
Type Description
Dashboard

Dashboard

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

Thrown when fails to make API call

GetDashboardsIDAsync(String, String, String, CancellationToken)

Retrieve a Dashboard

Declaration
System.Threading.Tasks.Task<Dashboard> GetDashboardsIDAsync(string dashboardID, string zapTraceSpan = null, string include = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String include

Includes the cell view properties in the response if set to properties (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Dashboard

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

Thrown when fails to make API call

GetDashboardsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve a Dashboard

Declaration
System.Threading.Tasks.Task<ApiResponse<Dashboard>> GetDashboardsIDAsyncWithHttpInfo(string dashboardID, string zapTraceSpan = null, string include = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String include

Includes the cell view properties in the response if set to properties (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Dashboard)

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

Thrown when fails to make API call

GetDashboardsIDCellsIDView(String, String, String)

Retrieve the view for a cell

Declaration
View GetDashboardsIDCellsIDView(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
View

View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsync(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration
System.Threading.Tasks.Task<View> GetDashboardsIDCellsIDViewAsync(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of View

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewAsyncWithHttpInfo(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration
System.Threading.Tasks.Task<ApiResponse<View>> GetDashboardsIDCellsIDViewAsyncWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (View)

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

Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithHttpInfo(String, String, String)

Retrieve the view for a cell

Declaration
ApiResponse<View> GetDashboardsIDCellsIDViewWithHttpInfo(string dashboardID, string cellID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The dashboard ID.

System.String cellID

The cell ID.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of View

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

Thrown when fails to make API call

GetDashboardsIDLabels(String, String)

List all labels for a dashboard

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

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

GetDashboardsIDLabelsAsync(String, String, CancellationToken)

List all labels for a dashboard

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

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

GetDashboardsIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a dashboard

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

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

GetDashboardsIDLabelsWithHttpInfo(String, String)

List all labels for a dashboard

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

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

GetDashboardsIDMembers(String, String)

List all dashboard members

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

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

GetDashboardsIDMembersAsync(String, String, CancellationToken)

List all dashboard members

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

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

GetDashboardsIDMembersAsyncWithHttpInfo(String, String, CancellationToken)

List all dashboard members

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

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

GetDashboardsIDMembersWithHttpInfo(String, String)

List all dashboard members

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

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

GetDashboardsIDOwners(String, String)

List all dashboard owners

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

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

GetDashboardsIDOwnersAsync(String, String, CancellationToken)

List all dashboard owners

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

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

GetDashboardsIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)

List all dashboard owners

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

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

GetDashboardsIDOwnersWithHttpInfo(String, String)

List all dashboard owners

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

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

GetDashboardsIDWithHttpInfo(String, String, String)

Retrieve a Dashboard

Declaration
ApiResponse<Dashboard> GetDashboardsIDWithHttpInfo(string dashboardID, string zapTraceSpan = null, string include = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

System.String include

Includes the cell view properties in the response if set to properties (optional)

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

ApiResponse of Dashboard

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

Thrown when fails to make API call

GetDashboardsWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, List<String>, String, String)

List all dashboards

Declaration
ApiResponse<Dashboards> GetDashboardsWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string owner = null, string sortBy = null, List<string> id = null, string orgID = null, string org = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.Nullable<System.Int32> offset

(optional)

System.Nullable<System.Int32> limit

(optional, default to 20)

System.Nullable<System.Boolean> descending

(optional, default to false)

System.String owner

A user identifier. Returns only dashboards where this user has the owner role. (optional)

System.String sortBy

The column to sort by. (optional)

List<System.String> id

A list of dashboard identifiers. Returns only the listed dashboards. If both id and owner are specified, only id is used. (optional)

System.String orgID

The identifier of the organization. (optional)

System.String org

The name of the organization. (optional)

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

ApiResponse of Dashboards

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

Thrown when fails to make API call

PatchDashboardsID(String, String, PatchDashboardRequest)

Update a dashboard

Declaration
Dashboard PatchDashboardsID(string dashboardID, string zapTraceSpan = null, PatchDashboardRequest patchDashboardRequest = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

PatchDashboardRequest patchDashboardRequest

(optional)

Returns
Type Description
Dashboard

Dashboard

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

Thrown when fails to make API call

PatchDashboardsIDAsync(String, String, PatchDashboardRequest, CancellationToken)

Update a dashboard

Declaration
System.Threading.Tasks.Task<Dashboard> PatchDashboardsIDAsync(string dashboardID, string zapTraceSpan = null, PatchDashboardRequest patchDashboardRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

PatchDashboardRequest patchDashboardRequest

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Dashboard

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

Thrown when fails to make API call

PatchDashboardsIDAsyncWithHttpInfo(String, String, PatchDashboardRequest, CancellationToken)

Update a dashboard

Declaration
System.Threading.Tasks.Task<ApiResponse<Dashboard>> PatchDashboardsIDAsyncWithHttpInfo(string dashboardID, string zapTraceSpan = null, PatchDashboardRequest patchDashboardRequest = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

PatchDashboardRequest patchDashboardRequest

(optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Dashboard)

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

Thrown when fails to make API call

PatchDashboardsIDCellsID(String, String, CellUpdate, String)

Update the non-positional information related to a cell

Declaration
Cell PatchDashboardsIDCellsID(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Cell

Cell

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDAsync(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell

Declaration
System.Threading.Tasks.Task<Cell> PatchDashboardsIDCellsIDAsync(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Cell

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDAsyncWithHttpInfo(String, String, CellUpdate, String, CancellationToken)

Update the non-positional information related to a cell

Declaration
System.Threading.Tasks.Task<ApiResponse<Cell>> PatchDashboardsIDCellsIDAsyncWithHttpInfo(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Cell)

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDView(String, String, View, String)

Update the view for a cell

Declaration
View PatchDashboardsIDCellsIDView(string dashboardID, string cellID, View view, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
View

View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsync(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration
System.Threading.Tasks.Task<View> PatchDashboardsIDCellsIDViewAsync(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewAsyncWithHttpInfo(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration
System.Threading.Tasks.Task<ApiResponse<View>> PatchDashboardsIDCellsIDViewAsyncWithHttpInfo(string dashboardID, string cellID, View view, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (View)

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithHttpInfo(String, String, View, String)

Update the view for a cell

Declaration
ApiResponse<View> PatchDashboardsIDCellsIDViewWithHttpInfo(string dashboardID, string cellID, View view, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

View view
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of View

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

Thrown when fails to make API call

PatchDashboardsIDCellsIDWithHttpInfo(String, String, CellUpdate, String)

Update the non-positional information related to a cell

Declaration
ApiResponse<Cell> PatchDashboardsIDCellsIDWithHttpInfo(string dashboardID, string cellID, CellUpdate cellUpdate, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String cellID

The ID of the cell to update.

CellUpdate cellUpdate
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Cell

Remarks

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

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

Thrown when fails to make API call

PatchDashboardsIDWithHttpInfo(String, String, PatchDashboardRequest)

Update a dashboard

Declaration
ApiResponse<Dashboard> PatchDashboardsIDWithHttpInfo(string dashboardID, string zapTraceSpan = null, PatchDashboardRequest patchDashboardRequest = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

System.String zapTraceSpan

OpenTracing span context (optional)

PatchDashboardRequest patchDashboardRequest

(optional)

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

ApiResponse of Dashboard

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

Thrown when fails to make API call

PostDashboards(CreateDashboardRequest, String)

Create a dashboard

Declaration
Dashboard PostDashboards(CreateDashboardRequest createDashboardRequest, string zapTraceSpan = null)
Parameters
Type Name Description
CreateDashboardRequest createDashboardRequest

Dashboard to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Dashboard

Dashboard

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

Thrown when fails to make API call

PostDashboardsAsync(CreateDashboardRequest, String, CancellationToken)

Create a dashboard

Declaration
System.Threading.Tasks.Task<Dashboard> PostDashboardsAsync(CreateDashboardRequest createDashboardRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
CreateDashboardRequest createDashboardRequest

Dashboard to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Dashboard

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

Thrown when fails to make API call

PostDashboardsAsyncWithHttpInfo(CreateDashboardRequest, String, CancellationToken)

Create a dashboard

Declaration
System.Threading.Tasks.Task<ApiResponse<Dashboard>> PostDashboardsAsyncWithHttpInfo(CreateDashboardRequest createDashboardRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
CreateDashboardRequest createDashboardRequest

Dashboard 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<Dashboard>>

Task of ApiResponse (Dashboard)

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

Thrown when fails to make API call

PostDashboardsIDCells(String, CreateCell, String)

Create a dashboard cell

Declaration
Cell PostDashboardsIDCells(string dashboardID, CreateCell createCell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Cell

Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsAsync(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration
System.Threading.Tasks.Task<Cell> PostDashboardsIDCellsAsync(string dashboardID, CreateCell createCell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Cell

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

Thrown when fails to make API call

PostDashboardsIDCellsAsyncWithHttpInfo(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration
System.Threading.Tasks.Task<ApiResponse<Cell>> PostDashboardsIDCellsAsyncWithHttpInfo(string dashboardID, CreateCell createCell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Cell)

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

Thrown when fails to make API call

PostDashboardsIDCellsWithHttpInfo(String, CreateCell, String)

Create a dashboard cell

Declaration
ApiResponse<Cell> PostDashboardsIDCellsWithHttpInfo(string dashboardID, CreateCell createCell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

CreateCell createCell

Cell that will be added

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Cell

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

Thrown when fails to make API call

PostDashboardsIDLabels(String, LabelMapping, String)

Add a label to a dashboard

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

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

PostDashboardsIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a dashboard

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

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

PostDashboardsIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a dashboard

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

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

PostDashboardsIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a dashboard

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

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

PostDashboardsIDMembers(String, AddResourceMemberRequestBody, String)

Add a member to a dashboard

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

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

PostDashboardsIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a dashboard

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

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

PostDashboardsIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a dashboard

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

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

PostDashboardsIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add a member to a dashboard

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

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

PostDashboardsIDOwners(String, AddResourceMemberRequestBody, String)

Add an owner to a dashboard

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

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

PostDashboardsIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a dashboard

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

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

PostDashboardsIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a dashboard

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

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

PostDashboardsIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add an owner to a dashboard

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

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

PostDashboardsWithHttpInfo(CreateDashboardRequest, String)

Create a dashboard

Declaration
ApiResponse<Dashboard> PostDashboardsWithHttpInfo(CreateDashboardRequest createDashboardRequest, string zapTraceSpan = null)
Parameters
Type Name Description
CreateDashboardRequest createDashboardRequest

Dashboard to create

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Dashboard

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

Thrown when fails to make API call

PutDashboardsIDCells(String, List<Cell>, String)

Replace cells in a dashboard

Declaration
Dashboard PutDashboardsIDCells(string dashboardID, List<Cell> cell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Dashboard

Dashboard

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

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

Thrown when fails to make API call

PutDashboardsIDCellsAsync(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard

Declaration
System.Threading.Tasks.Task<Dashboard> PutDashboardsIDCellsAsync(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Dashboard

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

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

Thrown when fails to make API call

PutDashboardsIDCellsAsyncWithHttpInfo(String, List<Cell>, String, CancellationToken)

Replace cells in a dashboard

Declaration
System.Threading.Tasks.Task<ApiResponse<Dashboard>> PutDashboardsIDCellsAsyncWithHttpInfo(string dashboardID, List<Cell> cell, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Dashboard)

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

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

Thrown when fails to make API call

PutDashboardsIDCellsWithHttpInfo(String, List<Cell>, String)

Replace cells in a dashboard

Declaration
ApiResponse<Dashboard> PutDashboardsIDCellsWithHttpInfo(string dashboardID, List<Cell> cell, string zapTraceSpan = null)
Parameters
Type Name Description
System.String dashboardID

The ID of the dashboard to update.

List<Cell> cell
System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Dashboard

Remarks

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

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

Thrown when fails to make API call

In This Article
Back to top Generated by DocFX