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

Class LegacyAuthorizationsService

Represents a collection of functions to interact with the API endpoints

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

Constructors

LegacyAuthorizationsService(Configuration)

Initializes a new instance of the LegacyAuthorizationsService class using Configuration object

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

An instance of Configuration

LegacyAuthorizationsService(String)

Initializes a new instance of the LegacyAuthorizationsService class.

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

Properties

Configuration

Gets or sets the configuration object

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

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

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

Methods

AddDefaultHeader(String, String)

Add default header.

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

Header field name.

System.String value

Header field value.

DefaultHeader()

Gets the default header.

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

Dictionary of HTTP header

DeleteLegacyAuthorizationsID(String, String)

Delete a legacy authorization

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

The ID of the legacy authorization to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

DeleteLegacyAuthorizationsIDAsync(String, String, CancellationToken)

Delete a legacy authorization

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

The ID of the legacy authorization 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

DeleteLegacyAuthorizationsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a legacy authorization

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

The ID of the legacy authorization 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

DeleteLegacyAuthorizationsIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a legacy authorization

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

The ID of the legacy authorization to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse

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

Thrown when fails to make API call

DeleteLegacyAuthorizationsIDWithHttpInfo(String, String)

Delete a legacy authorization

Declaration
public ApiResponse<object> DeleteLegacyAuthorizationsIDWithHttpInfo(string authID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization 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

DeleteLegacyAuthorizationsIDWithIRestResponse(String, String)

Delete a legacy authorization

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

The ID of the legacy authorization to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteLegacyAuthorizationsIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a legacy authorization

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

The ID of the legacy authorization to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

DeleteLegacyAuthorizationsIDWithRestRequest(String, String)

Delete a legacy authorization

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

The ID of the legacy authorization to delete.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

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

Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

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

The base path

GetLegacyAuthorizations(String, String, String, String, String, String, String)

List all legacy authorizations

Declaration
public Authorizations GetLegacyAuthorizations(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

Returns
Type Description
Authorizations

Authorizations

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

Thrown when fails to make API call

GetLegacyAuthorizationsAsync(String, String, String, String, String, String, String, CancellationToken)

List all legacy authorizations

Declaration
public async System.Threading.Tasks.Task<Authorizations> GetLegacyAuthorizationsAsync(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Authorizations

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

Thrown when fails to make API call

GetLegacyAuthorizationsAsyncWithHttpInfo(String, String, String, String, String, String, String, CancellationToken)

List all legacy authorizations

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorizations>> GetLegacyAuthorizationsAsyncWithHttpInfo(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Authorizations)

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

Thrown when fails to make API call

GetLegacyAuthorizationsAsyncWithIRestResponse(String, String, String, String, String, String, String, CancellationToken)

List all legacy authorizations

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetLegacyAuthorizationsAsyncWithIRestResponse(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Authorizations)

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

Thrown when fails to make API call

GetLegacyAuthorizationsID(String, String)

Retrieve a legacy authorization

Declaration
public Authorization GetLegacyAuthorizationsID(string authID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Authorization

Authorization

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDAsync(String, String, CancellationToken)

Retrieve a legacy authorization

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

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Authorization

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a legacy authorization

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

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of ApiResponse (Authorization)

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a legacy authorization

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

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Authorization)

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDWithHttpInfo(String, String)

Retrieve a legacy authorization

Declaration
public ApiResponse<Authorization> GetLegacyAuthorizationsIDWithHttpInfo(string authID, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Authorization

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDWithIRestResponse(String, String)

Retrieve a legacy authorization

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

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Authorization

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a legacy authorization

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

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Authorization

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

Thrown when fails to make API call

GetLegacyAuthorizationsIDWithRestRequest(String, String)

Retrieve a legacy authorization

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

The ID of the legacy authorization to get.

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Authorization

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

Thrown when fails to make API call

GetLegacyAuthorizationsWithHttpInfo(String, String, String, String, String, String, String)

List all legacy authorizations

Declaration
public ApiResponse<Authorizations> GetLegacyAuthorizationsWithHttpInfo(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

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

ApiResponse of Authorizations

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

Thrown when fails to make API call

GetLegacyAuthorizationsWithIRestResponse(String, String, String, String, String, String, String)

List all legacy authorizations

Declaration
public RestResponse GetLegacyAuthorizationsWithIRestResponse(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

Returns
Type Description
RestResponse

ApiResponse of Authorizations

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

Thrown when fails to make API call

GetLegacyAuthorizationsWithIRestResponseAsync(String, String, String, String, String, String, String, CancellationToken)

List all legacy authorizations

Declaration
public async System.Threading.Tasks.Task<RestResponse> GetLegacyAuthorizationsWithIRestResponseAsync(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Authorizations

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

Thrown when fails to make API call

GetLegacyAuthorizationsWithRestRequest(String, String, String, String, String, String, String)

List all legacy authorizations

Declaration
public RestRequest GetLegacyAuthorizationsWithRestRequest(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null)
Parameters
Type Name Description
System.String zapTraceSpan

OpenTracing span context (optional)

System.String userID

Only show legacy authorizations that belong to a user ID. (optional)

System.String user

Only show legacy authorizations that belong to a user name. (optional)

System.String orgID

Only show legacy authorizations that belong to an organization ID. (optional)

System.String org

Only show legacy authorizations that belong to a organization name. (optional)

System.String token

Only show legacy authorizations with a specified token (auth name). (optional)

System.String authID

Only show legacy authorizations with a specified auth ID. (optional)

Returns
Type Description
RestRequest

ApiResponse of Authorizations

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

Thrown when fails to make API call

PatchLegacyAuthorizationsID(String, AuthorizationUpdateRequest, String)

Update a legacy authorization to be active or inactive

Declaration
public Authorization PatchLegacyAuthorizationsID(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Authorization

Authorization

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDAsync(String, AuthorizationUpdateRequest, String, CancellationToken)

Update a legacy authorization to be active or inactive

Declaration
public async System.Threading.Tasks.Task<Authorization> PatchLegacyAuthorizationsIDAsync(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Authorization

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDAsyncWithHttpInfo(String, AuthorizationUpdateRequest, String, CancellationToken)

Update a legacy authorization to be active or inactive

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorization>> PatchLegacyAuthorizationsIDAsyncWithHttpInfo(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization 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<Authorization>>

Task of ApiResponse (Authorization)

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDAsyncWithIRestResponse(String, AuthorizationUpdateRequest, String, CancellationToken)

Update a legacy authorization to be active or inactive

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

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Authorization)

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDWithHttpInfo(String, AuthorizationUpdateRequest, String)

Update a legacy authorization to be active or inactive

Declaration
public ApiResponse<Authorization> PatchLegacyAuthorizationsIDWithHttpInfo(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Authorization

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDWithIRestResponse(String, AuthorizationUpdateRequest, String)

Update a legacy authorization to be active or inactive

Declaration
public RestResponse PatchLegacyAuthorizationsIDWithIRestResponse(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Authorization

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDWithIRestResponseAsync(String, AuthorizationUpdateRequest, String, CancellationToken)

Update a legacy authorization to be active or inactive

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

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Authorization

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

Thrown when fails to make API call

PatchLegacyAuthorizationsIDWithRestRequest(String, AuthorizationUpdateRequest, String)

Update a legacy authorization to be active or inactive

Declaration
public RestRequest PatchLegacyAuthorizationsIDWithRestRequest(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

AuthorizationUpdateRequest authorizationUpdateRequest

Legacy authorization to update

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Authorization

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

Thrown when fails to make API call

PostLegacyAuthorizations(LegacyAuthorizationPostRequest, String)

Create a legacy authorization

Declaration
public Authorization PostLegacyAuthorizations(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null)
Parameters
Type Name Description
LegacyAuthorizationPostRequest legacyAuthorizationPostRequest

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
Authorization

Authorization

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

Thrown when fails to make API call

PostLegacyAuthorizationsAsync(LegacyAuthorizationPostRequest, String, CancellationToken)

Create a legacy authorization

Declaration
public async System.Threading.Tasks.Task<Authorization> PostLegacyAuthorizationsAsync(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
LegacyAuthorizationPostRequest legacyAuthorizationPostRequest

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of Authorization

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

Thrown when fails to make API call

PostLegacyAuthorizationsAsyncWithHttpInfo(LegacyAuthorizationPostRequest, String, CancellationToken)

Create a legacy authorization

Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorization>> PostLegacyAuthorizationsAsyncWithHttpInfo(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
LegacyAuthorizationPostRequest legacyAuthorizationPostRequest

Legacy authorization 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<Authorization>>

Task of ApiResponse (Authorization)

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

Thrown when fails to make API call

PostLegacyAuthorizationsAsyncWithIRestResponse(LegacyAuthorizationPostRequest, String, CancellationToken)

Create a legacy authorization

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

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse (Authorization)

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

Thrown when fails to make API call

PostLegacyAuthorizationsIDPassword(String, PasswordResetBody, String)

Set a legacy authorization password

Declaration
public void PostLegacyAuthorizationsIDPassword(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

System.String zapTraceSpan

OpenTracing span context (optional)

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

Thrown when fails to make API call

PostLegacyAuthorizationsIDPasswordAsync(String, PasswordResetBody, String, CancellationToken)

Set a legacy authorization password

Declaration
public System.Threading.Tasks.Task PostLegacyAuthorizationsIDPasswordAsync(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

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

PostLegacyAuthorizationsIDPasswordAsyncWithHttpInfo(String, PasswordResetBody, String, CancellationToken)

Set a legacy authorization password

Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> PostLegacyAuthorizationsIDPasswordAsyncWithHttpInfo(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

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

PostLegacyAuthorizationsIDPasswordAsyncWithIRestResponse(String, PasswordResetBody, String, CancellationToken)

Set a legacy authorization password

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

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

Task of RestResponse

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

Thrown when fails to make API call

PostLegacyAuthorizationsIDPasswordWithHttpInfo(String, PasswordResetBody, String)

Set a legacy authorization password

Declaration
public ApiResponse<object> PostLegacyAuthorizationsIDPasswordWithHttpInfo(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

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

PostLegacyAuthorizationsIDPasswordWithIRestResponse(String, PasswordResetBody, String)

Set a legacy authorization password

Declaration
public RestResponse PostLegacyAuthorizationsIDPasswordWithIRestResponse(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Object(void)

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

Thrown when fails to make API call

PostLegacyAuthorizationsIDPasswordWithIRestResponseAsync(String, PasswordResetBody, String, CancellationToken)

Set a legacy authorization password

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

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Object(void)

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

Thrown when fails to make API call

PostLegacyAuthorizationsIDPasswordWithRestRequest(String, PasswordResetBody, String)

Set a legacy authorization password

Declaration
public RestRequest PostLegacyAuthorizationsIDPasswordWithRestRequest(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null)
Parameters
Type Name Description
System.String authID

The ID of the legacy authorization to update.

PasswordResetBody passwordResetBody

New password

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Object(void)

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

Thrown when fails to make API call

PostLegacyAuthorizationsWithHttpInfo(LegacyAuthorizationPostRequest, String)

Create a legacy authorization

Declaration
public ApiResponse<Authorization> PostLegacyAuthorizationsWithHttpInfo(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null)
Parameters
Type Name Description
LegacyAuthorizationPostRequest legacyAuthorizationPostRequest

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

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

ApiResponse of Authorization

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

Thrown when fails to make API call

PostLegacyAuthorizationsWithIRestResponse(LegacyAuthorizationPostRequest, String)

Create a legacy authorization

Declaration
public RestResponse PostLegacyAuthorizationsWithIRestResponse(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null)
Parameters
Type Name Description
LegacyAuthorizationPostRequest legacyAuthorizationPostRequest

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestResponse

ApiResponse of Authorization

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

Thrown when fails to make API call

PostLegacyAuthorizationsWithIRestResponseAsync(LegacyAuthorizationPostRequest, String, CancellationToken)

Create a legacy authorization

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

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

CancellationToken cancellationToken

Cancellation token

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

ApiResponse of Authorization

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

Thrown when fails to make API call

PostLegacyAuthorizationsWithRestRequest(LegacyAuthorizationPostRequest, String)

Create a legacy authorization

Declaration
public RestRequest PostLegacyAuthorizationsWithRestRequest(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null)
Parameters
Type Name Description
LegacyAuthorizationPostRequest legacyAuthorizationPostRequest

Legacy authorization to create

System.String zapTraceSpan

OpenTracing span context (optional)

Returns
Type Description
RestRequest

ApiResponse of Authorization

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

Thrown when fails to make API call

SetBasePath(String)

Sets the base path of the API client.

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

Implements

ILegacyAuthorizationsService
In This Article
Back to top Generated by DocFX