Class DashboardsService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

DashboardsService

Implements

IDashboardsService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class DashboardsService : object, IDashboardsService, IApiAccessor

Constructors

DashboardsService(Configuration)

Initializes a new instance of the DashboardsService class using Configuration object

Declaration

public DashboardsService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

DashboardsService(String)

Initializes a new instance of the DashboardsService class.

Declaration

public DashboardsService(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

DeleteDashboardsID(String, String)

Delete a dashboard

Declaration

public 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

public 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

public async 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

DeleteDashboardsIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsID(String, String, String)

Delete a dashboard cell

Declaration

public 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

public 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

public async 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

DeleteDashboardsIDCellsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a dashboard cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDCellsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsIDWithHttpInfo(String, String, String)

Delete a dashboard cell

Declaration

public 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

DeleteDashboardsIDCellsIDWithIRestResponse(String, String, String)

Delete a dashboard cell

Declaration

public RestResponse DeleteDashboardsIDCellsIDWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a dashboard cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDCellsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDCellsIDWithRestRequest(String, String, String)

Delete a dashboard cell

Declaration

public RestRequest DeleteDashboardsIDCellsIDWithRestRequest(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
RestRequest	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

public 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

public 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

public async 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

DeleteDashboardsIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a label from a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDLabelsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

DeleteDashboardsIDLabelsIDWithIRestResponse(String, String, String)

Delete a label from a dashboard

Declaration

public RestResponse DeleteDashboardsIDLabelsIDWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a label from a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDLabelsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDLabelsIDWithRestRequest(String, String, String)

Delete a label from a dashboard

Declaration

public RestRequest DeleteDashboardsIDLabelsIDWithRestRequest(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
RestRequest	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

public 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

public 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

public async 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

DeleteDashboardsIDMembersIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Remove a member from a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDMembersIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

DeleteDashboardsIDMembersIDWithIRestResponse(String, String, String)

Remove a member from a dashboard

Declaration

public RestResponse DeleteDashboardsIDMembersIDWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDMembersIDWithIRestResponseAsync(String, String, String, CancellationToken)

Remove a member from a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDMembersIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDMembersIDWithRestRequest(String, String, String)

Remove a member from a dashboard

Declaration

public RestRequest DeleteDashboardsIDMembersIDWithRestRequest(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
RestRequest	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

public 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

public 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

public async 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

DeleteDashboardsIDOwnersIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Remove an owner from a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDOwnersIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

DeleteDashboardsIDOwnersIDWithIRestResponse(String, String, String)

Remove an owner from a dashboard

Declaration

public RestResponse DeleteDashboardsIDOwnersIDWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDOwnersIDWithIRestResponseAsync(String, String, String, CancellationToken)

Remove an owner from a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDOwnersIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDOwnersIDWithRestRequest(String, String, String)

Remove an owner from a dashboard

Declaration

public RestRequest DeleteDashboardsIDOwnersIDWithRestRequest(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
RestRequest	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

public 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

DeleteDashboardsIDWithIRestResponse(String, String)

Delete a dashboard

Declaration

public RestResponse DeleteDashboardsIDWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteDashboardsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteDashboardsIDWithRestRequest(String, String)

Delete a dashboard

Declaration

public RestRequest DeleteDashboardsIDWithRestRequest(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
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

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

List all dashboards

Declaration

public 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

public async 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

public async 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

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

List all dashboards

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Dashboards)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsID(String, String, String)

Retrieve a Dashboard

Declaration

public 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

public async 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

public async 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

GetDashboardsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Retrieve a Dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

public async 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

public async 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

GetDashboardsIDCellsIDViewAsyncWithIRestResponse(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDCellsIDViewAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

GetDashboardsIDCellsIDViewWithIRestResponse(String, String, String)

Retrieve the view for a cell

Declaration

public RestResponse GetDashboardsIDCellsIDViewWithIRestResponse(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
RestResponse	ApiResponse of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithIRestResponseAsync(String, String, String, CancellationToken)

Retrieve the view for a cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDCellsIDViewWithIRestResponseAsync(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<RestResponse>	ApiResponse of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDCellsIDViewWithRestRequest(String, String, String)

Retrieve the view for a cell

Declaration

public RestRequest GetDashboardsIDCellsIDViewWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

GetDashboardsIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)

List all labels for a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDLabelsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

GetDashboardsIDLabelsWithIRestResponse(String, String)

List all labels for a dashboard

Declaration

public RestResponse GetDashboardsIDLabelsWithIRestResponse(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
RestResponse	ApiResponse of LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDLabelsWithIRestResponseAsync(String, String, CancellationToken)

List all labels for a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDLabelsWithIRestResponseAsync(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<RestResponse>	ApiResponse of LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDLabelsWithRestRequest(String, String)

List all labels for a dashboard

Declaration

public RestRequest GetDashboardsIDLabelsWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

GetDashboardsIDMembersAsyncWithIRestResponse(String, String, CancellationToken)

List all dashboard members

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDMembersAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (ResourceMembers)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDMembersWithHttpInfo(String, String)

List all dashboard members

Declaration

public 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

GetDashboardsIDMembersWithIRestResponse(String, String)

List all dashboard members

Declaration

public RestResponse GetDashboardsIDMembersWithIRestResponse(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
RestResponse	ApiResponse of ResourceMembers

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDMembersWithIRestResponseAsync(String, String, CancellationToken)

List all dashboard members

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDMembersWithIRestResponseAsync(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<RestResponse>	ApiResponse of ResourceMembers

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDMembersWithRestRequest(String, String)

List all dashboard members

Declaration

public RestRequest GetDashboardsIDMembersWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

GetDashboardsIDOwnersAsyncWithIRestResponse(String, String, CancellationToken)

List all dashboard owners

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDOwnersAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (ResourceOwners)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDOwnersWithHttpInfo(String, String)

List all dashboard owners

Declaration

public 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

GetDashboardsIDOwnersWithIRestResponse(String, String)

List all dashboard owners

Declaration

public RestResponse GetDashboardsIDOwnersWithIRestResponse(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
RestResponse	ApiResponse of ResourceOwners

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDOwnersWithIRestResponseAsync(String, String, CancellationToken)

List all dashboard owners

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDOwnersWithIRestResponseAsync(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<RestResponse>	ApiResponse of ResourceOwners

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDOwnersWithRestRequest(String, String)

List all dashboard owners

Declaration

public RestRequest GetDashboardsIDOwnersWithRestRequest(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
RestRequest	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

public 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

GetDashboardsIDWithIRestResponse(String, String, String)

Retrieve a Dashboard

Declaration

public RestResponse GetDashboardsIDWithIRestResponse(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
RestResponse	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Retrieve a Dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetDashboardsIDWithRestRequest(String, String, String)

Retrieve a Dashboard

Declaration

public RestRequest GetDashboardsIDWithRestRequest(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
RestRequest	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

public 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

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

List all dashboards

Declaration

public RestResponse GetDashboardsWithIRestResponse(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
RestResponse	ApiResponse of Dashboards

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

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

List all dashboards

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetDashboardsWithIRestResponseAsync(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<RestResponse>	ApiResponse of Dashboards

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

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

List all dashboards

Declaration

public RestRequest GetDashboardsWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

PatchDashboardsIDAsyncWithIRestResponse(String, String, PatchDashboardRequest, CancellationToken)

Update a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration

public 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

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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration

public async 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

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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration

public async 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)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDAsyncWithIRestResponse(String, String, CellUpdate, String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Cell)

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

public 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

public async 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

public async 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

PatchDashboardsIDCellsIDViewAsyncWithIRestResponse(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDViewAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PatchDashboardsIDCellsIDViewWithIRestResponse(String, String, View, String)

Update the view for a cell

Declaration

public RestResponse PatchDashboardsIDCellsIDViewWithIRestResponse(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
RestResponse	ApiResponse of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithIRestResponseAsync(String, String, View, String, CancellationToken)

Update the view for a cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDViewWithIRestResponseAsync(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<RestResponse>	ApiResponse of View

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDViewWithRestRequest(String, String, View, String)

Update the view for a cell

Declaration

public RestRequest PatchDashboardsIDCellsIDViewWithRestRequest(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
RestRequest	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 Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Declaration

public 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

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDWithIRestResponse(String, String, CellUpdate, String)

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

Declaration

public RestResponse PatchDashboardsIDCellsIDWithIRestResponse(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
RestResponse	ApiResponse of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDWithIRestResponseAsync(String, String, CellUpdate, String, CancellationToken)

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDCellsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDCellsIDWithRestRequest(String, String, CellUpdate, String)

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

Declaration

public RestRequest PatchDashboardsIDCellsIDWithRestRequest(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
RestRequest	ApiResponse of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDWithHttpInfo(String, String, PatchDashboardRequest)

Update a dashboard

Declaration

public 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

PatchDashboardsIDWithIRestResponse(String, String, PatchDashboardRequest)

Update a dashboard

Declaration

public RestResponse PatchDashboardsIDWithIRestResponse(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
RestResponse	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDWithIRestResponseAsync(String, String, PatchDashboardRequest, CancellationToken)

Update a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchDashboardsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchDashboardsIDWithRestRequest(String, String, PatchDashboardRequest)

Update a dashboard

Declaration

public RestRequest PatchDashboardsIDWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

PostDashboardsAsyncWithIRestResponse(CreateDashboardRequest, String, CancellationToken)

Create a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

public async 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

public async 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

PostDashboardsIDCellsAsyncWithIRestResponse(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDCellsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PostDashboardsIDCellsWithIRestResponse(String, CreateCell, String)

Create a dashboard cell

Declaration

public RestResponse PostDashboardsIDCellsWithIRestResponse(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
RestResponse	ApiResponse of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDCellsWithIRestResponseAsync(String, CreateCell, String, CancellationToken)

Create a dashboard cell

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDCellsWithIRestResponseAsync(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<RestResponse>	ApiResponse of Cell

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDCellsWithRestRequest(String, CreateCell, String)

Create a dashboard cell

Declaration

public RestRequest PostDashboardsIDCellsWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

PostDashboardsIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)

Add a label to a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDLabelsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PostDashboardsIDLabelsWithIRestResponse(String, LabelMapping, String)

Add a label to a dashboard

Declaration

public RestResponse PostDashboardsIDLabelsWithIRestResponse(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
RestResponse	ApiResponse of LabelResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)

Add a label to a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDLabelsWithIRestResponseAsync(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<RestResponse>	ApiResponse of LabelResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDLabelsWithRestRequest(String, LabelMapping, String)

Add a label to a dashboard

Declaration

public RestRequest PostDashboardsIDLabelsWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

PostDashboardsIDMembersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDMembersAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PostDashboardsIDMembersWithIRestResponse(String, AddResourceMemberRequestBody, String)

Add a member to a dashboard

Declaration

public RestResponse PostDashboardsIDMembersWithIRestResponse(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
RestResponse	ApiResponse of ResourceMember

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDMembersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDMembersWithIRestResponseAsync(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<RestResponse>	ApiResponse of ResourceMember

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDMembersWithRestRequest(String, AddResourceMemberRequestBody, String)

Add a member to a dashboard

Declaration

public RestRequest PostDashboardsIDMembersWithRestRequest(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
RestRequest	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

public 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

public async 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

public async 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

PostDashboardsIDOwnersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDOwnersAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

PostDashboardsIDOwnersWithIRestResponse(String, AddResourceMemberRequestBody, String)

Add an owner to a dashboard

Declaration

public RestResponse PostDashboardsIDOwnersWithIRestResponse(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
RestResponse	ApiResponse of ResourceOwner

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDOwnersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsIDOwnersWithIRestResponseAsync(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<RestResponse>	ApiResponse of ResourceOwner

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsIDOwnersWithRestRequest(String, AddResourceMemberRequestBody, String)

Add an owner to a dashboard

Declaration

public RestRequest PostDashboardsIDOwnersWithRestRequest(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
RestRequest	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

public 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

PostDashboardsWithIRestResponse(CreateDashboardRequest, String)

Create a dashboard

Declaration

public RestResponse PostDashboardsWithIRestResponse(CreateDashboardRequest createDashboardRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
CreateDashboardRequest	createDashboardRequest	Dashboard to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsWithIRestResponseAsync(CreateDashboardRequest, String, CancellationToken)

Create a dashboard

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostDashboardsWithIRestResponseAsync(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<RestResponse>	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostDashboardsWithRestRequest(CreateDashboardRequest, String)

Create a dashboard

Declaration

public RestRequest PostDashboardsWithRestRequest(CreateDashboardRequest createDashboardRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
CreateDashboardRequest	createDashboardRequest	Dashboard to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration

public 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

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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration

public async 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

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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration

public async 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)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PutDashboardsIDCellsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Dashboard)

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 Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Declaration

public 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

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutDashboardsIDCellsWithIRestResponse(String, List<Cell>, String)

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

Declaration

public RestResponse PutDashboardsIDCellsWithIRestResponse(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
RestResponse	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

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

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

Declaration

public async System.Threading.Tasks.Task<RestResponse> PutDashboardsIDCellsWithIRestResponseAsync(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<RestResponse>	ApiResponse of Dashboard

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutDashboardsIDCellsWithRestRequest(String, List<Cell>, String)

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

Declaration

public RestRequest PutDashboardsIDCellsWithRestRequest(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
RestRequest	ApiResponse of Dashboard

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

IDashboardsService