Class OrganizationsService
Represents a collection of functions to interact with the API endpoints
Inheritance
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class OrganizationsService : object, IOrganizationsService, IApiAccessorConstructors
OrganizationsService(Configuration)
Initializes a new instance of the OrganizationsService class using Configuration object
Declaration
public OrganizationsService(Configuration configuration = null)Parameters
| Type | Name | Description |
|---|---|---|
| InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
OrganizationsService(String)
Initializes a new instance of the OrganizationsService class.
Declaration
public OrganizationsService(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 |
DeleteOrgsID(String, String)
Delete an organization
Declaration
public void DeleteOrgsID(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDAsync(String, String, CancellationToken)
Delete an organization
Declaration
public System.Threading.Tasks.Task DeleteOrgsIDAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization 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 |
DeleteOrgsIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization 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 |
DeleteOrgsIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization 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 |
DeleteOrgsIDMembersID(String, String, String)
Remove a member from an organization
Declaration
public void DeleteOrgsIDMembersID(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDMembersIDAsync(String, String, String, CancellationToken)
Remove a member from an organization
Declaration
public System.Threading.Tasks.Task DeleteOrgsIDMembersIDAsync(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove a member from an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDMembersIDAsyncWithHttpInfo(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDMembersIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Remove a member from an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDMembersIDAsyncWithIRestResponse(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDMembersIDWithHttpInfo(String, String, String)
Remove a member from an organization
Declaration
public ApiResponse<object> DeleteOrgsIDMembersIDWithHttpInfo(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDMembersIDWithIRestResponse(String, String, String)
Remove a member from an organization
Declaration
public RestResponse DeleteOrgsIDMembersIDWithIRestResponse(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDMembersIDWithIRestResponseAsync(String, String, String, CancellationToken)
Remove a member from an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDMembersIDWithIRestResponseAsync(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDMembersIDWithRestRequest(String, String, String)
Remove a member from an organization
Declaration
public RestRequest DeleteOrgsIDMembersIDWithRestRequest(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the member to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersID(String, String, String)
Remove an owner from an organization
Declaration
public void DeleteOrgsIDOwnersID(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization ID. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDOwnersIDAsync(String, String, String, CancellationToken)
Remove an owner from an organization
Declaration
public System.Threading.Tasks.Task DeleteOrgsIDOwnersIDAsync(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove an owner from an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDOwnersIDAsyncWithHttpInfo(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Remove an owner from an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDOwnersIDAsyncWithIRestResponse(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersIDWithHttpInfo(String, String, String)
Remove an owner from an organization
Declaration
public ApiResponse<object> DeleteOrgsIDOwnersIDWithHttpInfo(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersIDWithIRestResponse(String, String, String)
Remove an owner from an organization
Declaration
public RestResponse DeleteOrgsIDOwnersIDWithIRestResponse(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersIDWithIRestResponseAsync(String, String, String, CancellationToken)
Remove an owner from an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDOwnersIDWithIRestResponseAsync(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDOwnersIDWithRestRequest(String, String, String)
Remove an owner from an organization
Declaration
public RestRequest DeleteOrgsIDOwnersIDWithRestRequest(string userID, string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userID | The ID of the owner to remove. |
| System.String | orgID | The organization 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 |
DeleteOrgsIDWithHttpInfo(String, String)
Delete an organization
Declaration
public ApiResponse<object> DeleteOrgsIDWithHttpInfo(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization 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 |
DeleteOrgsIDWithIRestResponse(String, String)
Delete an organization
Declaration
public RestResponse DeleteOrgsIDWithIRestResponse(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization 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 |
DeleteOrgsIDWithIRestResponseAsync(String, String, CancellationToken)
Delete an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDWithIRestResponseAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization 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 |
DeleteOrgsIDWithRestRequest(String, String)
Delete an organization
Declaration
public RestRequest DeleteOrgsIDWithRestRequest(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to delete. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()Returns
| Type | Description |
|---|---|
| System.String | The base path |
GetOrgs(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String)
List all organizations
Declaration
public Organizations GetOrgs(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
Returns
| Type | Description |
|---|---|
| Organizations | Organizations |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)
List all organizations
Declaration
public async System.Threading.Tasks.Task<Organizations> GetOrgsAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organizations> | Task of Organizations |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsAsyncWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)
List all organizations
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Organizations>> GetOrgsAsyncWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organizations>> | Task of ApiResponse (Organizations) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsAsyncWithIRestResponse(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)
List all organizations
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsAsyncWithIRestResponse(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Organizations) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsID(String, String)
Retrieve an organization
Declaration
public Organization GetOrgsID(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Organization | Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDAsync(String, String, CancellationToken)
Retrieve an organization
Declaration
public async System.Threading.Tasks.Task<Organization> GetOrgsIDAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Task of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Organization>> GetOrgsIDAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organization>> | Task of ApiResponse (Organization) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsIDAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Organization) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDMembers(String, String)
List all members of an organization
Declaration
public ResourceMembers GetOrgsIDMembers(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersAsync(String, String, CancellationToken)
List all members of an organization
Declaration
public async System.Threading.Tasks.Task<ResourceMembers> GetOrgsIDMembersAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersAsyncWithHttpInfo(String, String, CancellationToken)
List all members of an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetOrgsIDMembersAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersAsyncWithIRestResponse(String, String, CancellationToken)
List all members of an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsIDMembersAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersWithHttpInfo(String, String)
List all members of an organization
Declaration
public ApiResponse<ResourceMembers> GetOrgsIDMembersWithHttpInfo(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersWithIRestResponse(String, String)
List all members of an organization
Declaration
public RestResponse GetOrgsIDMembersWithIRestResponse(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersWithIRestResponseAsync(String, String, CancellationToken)
List all members of an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsIDMembersWithIRestResponseAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDMembersWithRestRequest(String, String)
List all members of an organization
Declaration
public RestRequest GetOrgsIDMembersWithRestRequest(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwners(String, String)
List all owners of an organization
Declaration
public ResourceOwners GetOrgsIDOwners(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersAsync(String, String, CancellationToken)
List all owners of an organization
Declaration
public async System.Threading.Tasks.Task<ResourceOwners> GetOrgsIDOwnersAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)
List all owners of an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetOrgsIDOwnersAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersAsyncWithIRestResponse(String, String, CancellationToken)
List all owners of an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsIDOwnersAsyncWithIRestResponse(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersWithHttpInfo(String, String)
List all owners of an organization
Declaration
public ApiResponse<ResourceOwners> GetOrgsIDOwnersWithHttpInfo(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersWithIRestResponse(String, String)
List all owners of an organization
Declaration
public RestResponse GetOrgsIDOwnersWithIRestResponse(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersWithIRestResponseAsync(String, String, CancellationToken)
List all owners of an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsIDOwnersWithIRestResponseAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDOwnersWithRestRequest(String, String)
List all owners of an organization
Declaration
public RestRequest GetOrgsIDOwnersWithRestRequest(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
GetOrgsIDWithHttpInfo(String, String)
Retrieve an organization
Declaration
public ApiResponse<Organization> GetOrgsIDWithHttpInfo(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Organization> | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDWithIRestResponse(String, String)
Retrieve an organization
Declaration
public RestResponse GetOrgsIDWithIRestResponse(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsIDWithIRestResponseAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDWithRestRequest(String, String)
Retrieve an organization
Declaration
public RestRequest GetOrgsIDWithRestRequest(string orgID, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String)
List all organizations
Declaration
public ApiResponse<Organizations> GetOrgsWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Organizations> | ApiResponse of Organizations |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsWithIRestResponse(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String)
List all organizations
Declaration
public RestResponse GetOrgsWithIRestResponse(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Organizations |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsWithIRestResponseAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)
List all organizations
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetOrgsWithIRestResponseAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Organizations |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsWithRestRequest(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String)
List all organizations
Declaration
public RestRequest GetOrgsWithRestRequest(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = 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 | org | Filter organizations to a specific organization name. (optional) |
| System.String | orgID | Filter organizations to a specific organization ID. (optional) |
| System.String | userID | Filter organizations to a specific user ID. (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Organizations |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsID(String, PatchOrganizationRequest, String)
Update an organization
Declaration
public Organization PatchOrgsID(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Organization | Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDAsync(String, PatchOrganizationRequest, String, CancellationToken)
Update an organization
Declaration
public async System.Threading.Tasks.Task<Organization> PatchOrgsIDAsync(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Task of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDAsyncWithHttpInfo(String, PatchOrganizationRequest, String, CancellationToken)
Update an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Organization>> PatchOrgsIDAsyncWithHttpInfo(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organization>> | Task of ApiResponse (Organization) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDAsyncWithIRestResponse(String, PatchOrganizationRequest, String, CancellationToken)
Update an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchOrgsIDAsyncWithIRestResponse(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Organization) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDWithHttpInfo(String, PatchOrganizationRequest, String)
Update an organization
Declaration
public ApiResponse<Organization> PatchOrgsIDWithHttpInfo(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Organization> | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDWithIRestResponse(String, PatchOrganizationRequest, String)
Update an organization
Declaration
public RestResponse PatchOrgsIDWithIRestResponse(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDWithIRestResponseAsync(String, PatchOrganizationRequest, String, CancellationToken)
Update an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchOrgsIDWithIRestResponseAsync(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDWithRestRequest(String, PatchOrganizationRequest, String)
Update an organization
Declaration
public RestRequest PatchOrgsIDWithRestRequest(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The ID of the organization to get. |
| PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgs(PostOrganizationRequest, String)
Create an organization
Declaration
public Organization PostOrgs(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Organization | Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsAsync(PostOrganizationRequest, String, CancellationToken)
Create an organization
Declaration
public async System.Threading.Tasks.Task<Organization> PostOrgsAsync(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Task of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsAsyncWithHttpInfo(PostOrganizationRequest, String, CancellationToken)
Create an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Organization>> PostOrgsAsyncWithHttpInfo(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization 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<Organization>> | Task of ApiResponse (Organization) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsAsyncWithIRestResponse(PostOrganizationRequest, String, CancellationToken)
Create an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostOrgsAsyncWithIRestResponse(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Organization) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDMembers(String, AddResourceMemberRequestBody, String)
Add a member to an organization
Declaration
public ResourceMember PostOrgsIDMembers(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to an organization
Declaration
public async System.Threading.Tasks.Task<ResourceMember> PostOrgsIDMembersAsync(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostOrgsIDMembersAsyncWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostOrgsIDMembersAsyncWithIRestResponse(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add a member to an organization
Declaration
public ApiResponse<ResourceMember> PostOrgsIDMembersWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersWithIRestResponse(String, AddResourceMemberRequestBody, String)
Add a member to an organization
Declaration
public RestResponse PostOrgsIDMembersWithIRestResponse(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostOrgsIDMembersWithIRestResponseAsync(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDMembersWithRestRequest(String, AddResourceMemberRequestBody, String)
Add a member to an organization
Declaration
public RestRequest PostOrgsIDMembersWithRestRequest(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwners(String, AddResourceMemberRequestBody, String)
Add an owner to an organization
Declaration
public ResourceOwner PostOrgsIDOwners(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to an organization
Declaration
public async System.Threading.Tasks.Task<ResourceOwner> PostOrgsIDOwnersAsync(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to an organization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostOrgsIDOwnersAsyncWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostOrgsIDOwnersAsyncWithIRestResponse(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add an owner to an organization
Declaration
public ApiResponse<ResourceOwner> PostOrgsIDOwnersWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersWithIRestResponse(String, AddResourceMemberRequestBody, String)
Add an owner to an organization
Declaration
public RestResponse PostOrgsIDOwnersWithIRestResponse(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostOrgsIDOwnersWithIRestResponseAsync(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsIDOwnersWithRestRequest(String, AddResourceMemberRequestBody, String)
Add an owner to an organization
Declaration
public RestRequest PostOrgsIDOwnersWithRestRequest(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgID | The organization 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 |
PostOrgsWithHttpInfo(PostOrganizationRequest, String)
Create an organization
Declaration
public ApiResponse<Organization> PostOrgsWithHttpInfo(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Organization> | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsWithIRestResponse(PostOrganizationRequest, String)
Create an organization
Declaration
public RestResponse PostOrgsWithIRestResponse(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestResponse | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsWithIRestResponseAsync(PostOrganizationRequest, String, CancellationToken)
Create an organization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostOrgsWithIRestResponseAsync(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<RestResponse> | ApiResponse of Organization |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsWithRestRequest(PostOrganizationRequest, String)
Create an organization
Declaration
public RestRequest PostOrgsWithRestRequest(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostOrganizationRequest | postOrganizationRequest | Organization to create |
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| RestRequest | ApiResponse of Organization |
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 |