Interface IScraperTargetsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IScraperTargetsService : IApiAccessor

Methods

DeleteScrapersID(String, String)

Delete a scraper target

Declaration

void DeleteScrapersID(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteScrapersIDAsync(String, String, CancellationToken)

Delete a scraper target

Declaration

System.Threading.Tasks.Task DeleteScrapersIDAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
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

DeleteScrapersIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
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

DeleteScrapersIDLabelsID(String, String, String)

Delete a label from a scraper target

Declaration

void DeleteScrapersIDLabelsID(string scraperTargetID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target ID.
System.String	labelID	The label ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteScrapersIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a scraper target

Declaration

System.Threading.Tasks.Task DeleteScrapersIDLabelsIDAsync(string scraperTargetID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target ID.
System.String	labelID	The label 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

DeleteScrapersIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDLabelsIDAsyncWithHttpInfo(string scraperTargetID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target ID.
System.String	labelID	The label 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

DeleteScrapersIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a scraper target

Declaration

ApiResponse<object> DeleteScrapersIDLabelsIDWithHttpInfo(string scraperTargetID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target ID.
System.String	labelID	The label 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

DeleteScrapersIDMembersID(String, String, String)

Remove a member from a scraper target

Declaration

void DeleteScrapersIDMembersID(string userID, string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of member to remove.
System.String	scraperTargetID	The scraper target ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteScrapersIDMembersIDAsync(String, String, String, CancellationToken)

Remove a member from a scraper target

Declaration

System.Threading.Tasks.Task DeleteScrapersIDMembersIDAsync(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of member to remove.
System.String	scraperTargetID	The scraper target 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

DeleteScrapersIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove a member from a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDMembersIDAsyncWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of member to remove.
System.String	scraperTargetID	The scraper target 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

DeleteScrapersIDMembersIDWithHttpInfo(String, String, String)

Remove a member from a scraper target

Declaration

ApiResponse<object> DeleteScrapersIDMembersIDWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of member to remove.
System.String	scraperTargetID	The scraper target 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

DeleteScrapersIDOwnersID(String, String, String)

Remove an owner from a scraper target

Declaration

void DeleteScrapersIDOwnersID(string userID, string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of owner to remove.
System.String	scraperTargetID	The scraper target ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteScrapersIDOwnersIDAsync(String, String, String, CancellationToken)

Remove an owner from a scraper target

Declaration

System.Threading.Tasks.Task DeleteScrapersIDOwnersIDAsync(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of owner to remove.
System.String	scraperTargetID	The scraper target 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

DeleteScrapersIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove an owner from a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDOwnersIDAsyncWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of owner to remove.
System.String	scraperTargetID	The scraper target 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

DeleteScrapersIDOwnersIDWithHttpInfo(String, String, String)

Remove an owner from a scraper target

Declaration

ApiResponse<object> DeleteScrapersIDOwnersIDWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of owner to remove.
System.String	scraperTargetID	The scraper target 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

DeleteScrapersIDWithHttpInfo(String, String)

Delete a scraper target

Declaration

ApiResponse<object> DeleteScrapersIDWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
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

GetScrapers(String, String, List<String>, String, String)

List all scraper targets

Declaration

ScraperTargetResponses GetScrapers(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	name	Specifies the name of the scraper target. (optional)
List<System.String>	id	List of scraper target IDs to return. If both id and owner are specified, only id is used. (optional)
System.String	orgID	Specifies the organization ID of the scraper target. (optional)
System.String	org	Specifies the organization name of the scraper target. (optional)

Returns

Type	Description
ScraperTargetResponses	ScraperTargetResponses

Exceptions

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

GetScrapersAsync(String, String, List<String>, String, String, CancellationToken)

List all scraper targets

Declaration

System.Threading.Tasks.Task<ScraperTargetResponses> GetScrapersAsync(string zapTraceSpan = null, string name = 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.String	name	Specifies the name of the scraper target. (optional)
List<System.String>	id	List of scraper target IDs to return. If both id and owner are specified, only id is used. (optional)
System.String	orgID	Specifies the organization ID of the scraper target. (optional)
System.String	org	Specifies the organization name of the scraper target. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ScraperTargetResponses>	Task of ScraperTargetResponses

Exceptions

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

GetScrapersAsyncWithHttpInfo(String, String, List<String>, String, String, CancellationToken)

List all scraper targets

Declaration

System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponses>> GetScrapersAsyncWithHttpInfo(string zapTraceSpan = null, string name = 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.String	name	Specifies the name of the scraper target. (optional)
List<System.String>	id	List of scraper target IDs to return. If both id and owner are specified, only id is used. (optional)
System.String	orgID	Specifies the organization ID of the scraper target. (optional)
System.String	org	Specifies the organization name of the scraper target. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponses>>	Task of ApiResponse (ScraperTargetResponses)

Exceptions

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

GetScrapersID(String, String)

Retrieve a scraper target

Declaration

ScraperTargetResponse GetScrapersID(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ScraperTargetResponse	ScraperTargetResponse

Exceptions

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

GetScrapersIDAsync(String, String, CancellationToken)

Retrieve a scraper target

Declaration

System.Threading.Tasks.Task<ScraperTargetResponse> GetScrapersIDAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ScraperTargetResponse>	Task of ScraperTargetResponse

Exceptions

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

GetScrapersIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponse>> GetScrapersIDAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>>	Task of ApiResponse (ScraperTargetResponse)

Exceptions

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

GetScrapersIDLabels(String, String)

List all labels for a scraper target

Declaration

LabelsResponse GetScrapersIDLabels(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDLabelsAsync(String, String, CancellationToken)

List all labels for a scraper target

Declaration

System.Threading.Tasks.Task<LabelsResponse> GetScrapersIDLabelsAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetScrapersIDLabelsAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDLabelsWithHttpInfo(String, String)

List all labels for a scraper target

Declaration

ApiResponse<LabelsResponse> GetScrapersIDLabelsWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDMembers(String, String)

List all users with member privileges for a scraper target

Declaration

ResourceMembers GetScrapersIDMembers(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDMembersAsync(String, String, CancellationToken)

List all users with member privileges for a scraper target

Declaration

System.Threading.Tasks.Task<ResourceMembers> GetScrapersIDMembersAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDMembersAsyncWithHttpInfo(String, String, CancellationToken)

List all users with member privileges for a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetScrapersIDMembersAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDMembersWithHttpInfo(String, String)

List all users with member privileges for a scraper target

Declaration

ApiResponse<ResourceMembers> GetScrapersIDMembersWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDOwners(String, String)

List all owners of a scraper target

Declaration

ResourceOwners GetScrapersIDOwners(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDOwnersAsync(String, String, CancellationToken)

List all owners of a scraper target

Declaration

System.Threading.Tasks.Task<ResourceOwners> GetScrapersIDOwnersAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)

List all owners of a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetScrapersIDOwnersAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDOwnersWithHttpInfo(String, String)

List all owners of a scraper target

Declaration

ApiResponse<ResourceOwners> GetScrapersIDOwnersWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

GetScrapersIDWithHttpInfo(String, String)

Retrieve a scraper target

Declaration

ApiResponse<ScraperTargetResponse> GetScrapersIDWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>	ApiResponse of ScraperTargetResponse

Exceptions

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

GetScrapersWithHttpInfo(String, String, List<String>, String, String)

List all scraper targets

Declaration

ApiResponse<ScraperTargetResponses> GetScrapersWithHttpInfo(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	name	Specifies the name of the scraper target. (optional)
List<System.String>	id	List of scraper target IDs to return. If both id and owner are specified, only id is used. (optional)
System.String	orgID	Specifies the organization ID of the scraper target. (optional)
System.String	org	Specifies the organization name of the scraper target. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponses>	ApiResponse of ScraperTargetResponses

Exceptions

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

PatchScrapersID(String, ScraperTargetRequest, String)

Update a scraper target

Declaration

ScraperTargetResponse PatchScrapersID(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
ScraperTargetRequest	scraperTargetRequest	Scraper target update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ScraperTargetResponse	ScraperTargetResponse

Exceptions

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

PatchScrapersIDAsync(String, ScraperTargetRequest, String, CancellationToken)

Update a scraper target

Declaration

System.Threading.Tasks.Task<ScraperTargetResponse> PatchScrapersIDAsync(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
ScraperTargetRequest	scraperTargetRequest	Scraper target update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ScraperTargetResponse>	Task of ScraperTargetResponse

Exceptions

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

PatchScrapersIDAsyncWithHttpInfo(String, ScraperTargetRequest, String, CancellationToken)

Update a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponse>> PatchScrapersIDAsyncWithHttpInfo(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
ScraperTargetRequest	scraperTargetRequest	Scraper target 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<ScraperTargetResponse>>	Task of ApiResponse (ScraperTargetResponse)

Exceptions

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

PatchScrapersIDWithHttpInfo(String, ScraperTargetRequest, String)

Update a scraper target

Declaration

ApiResponse<ScraperTargetResponse> PatchScrapersIDWithHttpInfo(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The identifier of the scraper target.
ScraperTargetRequest	scraperTargetRequest	Scraper target update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>	ApiResponse of ScraperTargetResponse

Exceptions

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

PostScrapers(ScraperTargetRequest, String)

Create a scraper target

Declaration

ScraperTargetResponse PostScrapers(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
ScraperTargetRequest	scraperTargetRequest	Scraper target to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ScraperTargetResponse	ScraperTargetResponse

Exceptions

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

PostScrapersAsync(ScraperTargetRequest, String, CancellationToken)

Create a scraper target

Declaration

System.Threading.Tasks.Task<ScraperTargetResponse> PostScrapersAsync(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetRequest	scraperTargetRequest	Scraper target to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ScraperTargetResponse>	Task of ScraperTargetResponse

Exceptions

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

PostScrapersAsyncWithHttpInfo(ScraperTargetRequest, String, CancellationToken)

Create a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponse>> PostScrapersAsyncWithHttpInfo(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetRequest	scraperTargetRequest	Scraper target 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<ScraperTargetResponse>>	Task of ApiResponse (ScraperTargetResponse)

Exceptions

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

PostScrapersIDLabels(String, LabelMapping, String)

Add a label to a scraper target

Declaration

LabelResponse PostScrapersIDLabels(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a scraper target

Declaration

System.Threading.Tasks.Task<LabelResponse> PostScrapersIDLabelsAsync(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostScrapersIDLabelsAsyncWithHttpInfo(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a scraper target

Declaration

ApiResponse<LabelResponse> PostScrapersIDLabelsWithHttpInfo(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDMembers(String, AddResourceMemberRequestBody, String)

Add a member to a scraper target

Declaration

ResourceMember PostScrapersIDMembers(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a scraper target

Declaration

System.Threading.Tasks.Task<ResourceMember> PostScrapersIDMembersAsync(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostScrapersIDMembersAsyncWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add a member to a scraper target

Declaration

ApiResponse<ResourceMember> PostScrapersIDMembersWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDOwners(String, AddResourceMemberRequestBody, String)

Add an owner to a scraper target

Declaration

ResourceOwner PostScrapersIDOwners(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a scraper target

Declaration

System.Threading.Tasks.Task<ResourceOwner> PostScrapersIDOwnersAsync(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a scraper target

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostScrapersIDOwnersAsyncWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add an owner to a scraper target

Declaration

ApiResponse<ResourceOwner> PostScrapersIDOwnersWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	scraperTargetID	The scraper target 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

PostScrapersWithHttpInfo(ScraperTargetRequest, String)

Create a scraper target

Declaration

ApiResponse<ScraperTargetResponse> PostScrapersWithHttpInfo(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
ScraperTargetRequest	scraperTargetRequest	Scraper target to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>	ApiResponse of ScraperTargetResponse

Exceptions

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