Skip to content

AdScannerAPI.md

Latest commit

 

History

History
908 lines (576 loc) · 24.1 KB

AdScannerAPI.md

File metadata and controls

908 lines (576 loc) · 24.1 KB
Raw

\AdScannerAPI

All URIs are relative to https://up.go-adserver.com

Method HTTP request Description
ApiV1AdScannerGet Get /api/v1/ad-scanner List scan tasks.
ApiV1AdScannerIdDelete Delete /api/v1/ad-scanner/{id} Delete a scan task.
ApiV1AdScannerIdIgnoreDomainPut Put /api/v1/ad-scanner/{id}/ignore-domain Ignore (or un-ignore) a flagged domain on a task.
ApiV1AdScannerIdManualItemsGet Get /api/v1/ad-scanner/{id}/manual-items List a manual task's items.
ApiV1AdScannerIdManualItemsItemIdStatePut Put /api/v1/ad-scanner/{id}/manual-items/{itemId}/state Pause, resume or delete a manual item.
ApiV1AdScannerIdManualItemsPost Post /api/v1/ad-scanner/{id}/manual-items Add or edit a manual item.
ApiV1AdScannerIdPut Put /api/v1/ad-scanner/{id} Replace a task's name, tags and config.
ApiV1AdScannerIdToggleActivePut Put /api/v1/ad-scanner/{id}/toggle-active Start or stop a scan task.
ApiV1AdScannerPost Post /api/v1/ad-scanner Create a scan task.
ApiV1AdScannerReportHashGet Get /api/v1/ad-scanner/report/{hash} One scan's full report.
ApiV1AdScannerReportsGet Get /api/v1/ad-scanner/reports List scan results.
ApiV1AdScannerStatsGet Get /api/v1/ad-scanner/stats Scan volume and proxy bandwidth.
ApiV1AdScannerTagsGet Get /api/v1/ad-scanner/tags Tags used on the account's scan tasks.

ApiV1AdScannerGet

ApiV1AdScannerGet(ctx).Execute()

List scan tasks.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerGetRequest struct via the builder pattern

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdDelete

ApiV1AdScannerIdDelete(ctx, id).Execute()

Delete a scan task.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdDelete(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdIgnoreDomainPut

ApiV1AdScannerIdIgnoreDomainPut(ctx, id).ApiV1AdScannerIdIgnoreDomainPutRequest(apiV1AdScannerIdIgnoreDomainPutRequest).Execute()

Ignore (or un-ignore) a flagged domain on a task.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1AdScannerIdIgnoreDomainPutRequest := *openapiclient.NewApiV1AdScannerIdIgnoreDomainPutRequest("Type_example", "Value_example") // ApiV1AdScannerIdIgnoreDomainPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdIgnoreDomainPut(context.Background(), id).ApiV1AdScannerIdIgnoreDomainPutRequest(apiV1AdScannerIdIgnoreDomainPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdIgnoreDomainPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdIgnoreDomainPutRequest struct via the builder pattern

Name Type Description Notes

apiV1AdScannerIdIgnoreDomainPutRequest | ApiV1AdScannerIdIgnoreDomainPutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdManualItemsGet

ApiV1AdScannerIdManualItemsGet(ctx, id).Execute()

List a manual task's items.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdManualItemsGet(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdManualItemsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdManualItemsGetRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdManualItemsItemIdStatePut

ApiV1AdScannerIdManualItemsItemIdStatePut(ctx, id, itemId).ApiV1AdScannerIdManualItemsItemIdStatePutRequest(apiV1AdScannerIdManualItemsItemIdStatePutRequest).Execute()

Pause, resume or delete a manual item.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	itemId := int32(56) // int32 | 
	apiV1AdScannerIdManualItemsItemIdStatePutRequest := *openapiclient.NewApiV1AdScannerIdManualItemsItemIdStatePutRequest() // ApiV1AdScannerIdManualItemsItemIdStatePutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdManualItemsItemIdStatePut(context.Background(), id, itemId).ApiV1AdScannerIdManualItemsItemIdStatePutRequest(apiV1AdScannerIdManualItemsItemIdStatePutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdManualItemsItemIdStatePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32
itemId int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdManualItemsItemIdStatePutRequest struct via the builder pattern

Name Type Description Notes

apiV1AdScannerIdManualItemsItemIdStatePutRequest | ApiV1AdScannerIdManualItemsItemIdStatePutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdManualItemsPost

ApiV1AdScannerIdManualItemsPost(ctx, id).ApiV1AdScannerIdManualItemsPostRequest(apiV1AdScannerIdManualItemsPostRequest).Execute()

Add or edit a manual item.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1AdScannerIdManualItemsPostRequest := *openapiclient.NewApiV1AdScannerIdManualItemsPostRequest("Value_example") // ApiV1AdScannerIdManualItemsPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdManualItemsPost(context.Background(), id).ApiV1AdScannerIdManualItemsPostRequest(apiV1AdScannerIdManualItemsPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdManualItemsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdManualItemsPostRequest struct via the builder pattern

Name Type Description Notes

apiV1AdScannerIdManualItemsPostRequest | ApiV1AdScannerIdManualItemsPostRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdPut

ApiV1AdScannerIdPut(ctx, id).ApiV1AdScannerIdPutRequest(apiV1AdScannerIdPutRequest).Execute()

Replace a task's name, tags and config.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1AdScannerIdPutRequest := *openapiclient.NewApiV1AdScannerIdPutRequest() // ApiV1AdScannerIdPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdPut(context.Background(), id).ApiV1AdScannerIdPutRequest(apiV1AdScannerIdPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdPutRequest struct via the builder pattern

Name Type Description Notes

apiV1AdScannerIdPutRequest | ApiV1AdScannerIdPutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerIdToggleActivePut

ApiV1AdScannerIdToggleActivePut(ctx, id).ApiV1AdScannerIdToggleActivePutRequest(apiV1AdScannerIdToggleActivePutRequest).Execute()

Start or stop a scan task.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1AdScannerIdToggleActivePutRequest := *openapiclient.NewApiV1AdScannerIdToggleActivePutRequest() // ApiV1AdScannerIdToggleActivePutRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerIdToggleActivePut(context.Background(), id).ApiV1AdScannerIdToggleActivePutRequest(apiV1AdScannerIdToggleActivePutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerIdToggleActivePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerIdToggleActivePutRequest struct via the builder pattern

Name Type Description Notes

apiV1AdScannerIdToggleActivePutRequest | ApiV1AdScannerIdToggleActivePutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerPost

ApiV1AdScannerPost(ctx).ApiV1AdScannerPostRequest(apiV1AdScannerPostRequest).Execute()

Create a scan task.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1AdScannerPostRequest := *openapiclient.NewApiV1AdScannerPostRequest("Name_example") // ApiV1AdScannerPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerPost(context.Background()).ApiV1AdScannerPostRequest(apiV1AdScannerPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerPostRequest struct via the builder pattern

Name Type Description Notes
apiV1AdScannerPostRequest ApiV1AdScannerPostRequest

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerReportHashGet

ApiV1AdScannerReportHashGet(ctx, hash).Execute()

One scan's full report.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	hash := "hash_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerReportHashGet(context.Background(), hash).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerReportHashGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
hash string

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerReportHashGetRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerReportsGet

ApiV1AdScannerReportsGet(ctx).Datestart(datestart).Dateend(dateend).ScanType(scanType).ScanTarget(scanTarget).ScanState(scanState).Page(page).Execute()

List scan results.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	datestart := time.Now() // string |  (optional)
	dateend := time.Now() // string |  (optional)
	scanType := "scanType_example" // string |  (optional)
	scanTarget := "scanTarget_example" // string |  (optional)
	scanState := int32(56) // int32 |  (optional)
	page := int32(56) // int32 |  (optional) (default to 1)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerReportsGet(context.Background()).Datestart(datestart).Dateend(dateend).ScanType(scanType).ScanTarget(scanTarget).ScanState(scanState).Page(page).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerReportsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerReportsGetRequest struct via the builder pattern

Name Type Description Notes
datestart string
dateend string
scanType string
scanTarget string
scanState int32
page int32 [default to 1]

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerStatsGet

ApiV1AdScannerStatsGet(ctx).Datestart(datestart).Dateend(dateend).StatsSelcols(statsSelcols).ConfigId(configId).Country(country).ProxyUsed(proxyUsed).Execute()

Scan volume and proxy bandwidth.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	datestart := time.Now() // string |  (optional)
	dateend := time.Now() // string |  (optional)
	statsSelcols := "scandate,config_id" // string |  (optional)
	configId := int32(56) // int32 |  (optional)
	country := "country_example" // string |  (optional)
	proxyUsed := int32(56) // int32 |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerStatsGet(context.Background()).Datestart(datestart).Dateend(dateend).StatsSelcols(statsSelcols).ConfigId(configId).Country(country).ProxyUsed(proxyUsed).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerStatsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerStatsGetRequest struct via the builder pattern

Name Type Description Notes
datestart string
dateend string
statsSelcols string
configId int32
country string
proxyUsed int32

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1AdScannerTagsGet

ApiV1AdScannerTagsGet(ctx).Execute()

Tags used on the account's scan tasks.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdScannerAPI.ApiV1AdScannerTagsGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdScannerAPI.ApiV1AdScannerTagsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiApiV1AdScannerTagsGetRequest struct via the builder pattern

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]