Skip to content

URLScannerApi.md

Latest commit

 

History

History
449 lines (324 loc) · 18 KB

URLScannerApi.md

File metadata and controls

449 lines (324 loc) · 18 KB

cloudflare_dart.api.URLScannerApi

Load the API package

import 'package:cloudflare_dart/api.dart';

All URIs are relative to https://api.cloudflare.com/client/v4

Method HTTP request Description
urlscannerCreateScanBulkV2 POST /accounts/{account_id}/urlscanner/v2/bulk Bulk create URL Scans
urlscannerCreateScanV2 POST /accounts/{account_id}/urlscanner/v2/scan Create URL Scan
urlscannerGetResponseV2 GET /accounts/{account_id}/urlscanner/v2/responses/{response_id} Get raw response
urlscannerGetScanDomV2 GET /accounts/{account_id}/urlscanner/v2/dom/{scan_id} Get URL scan's DOM
urlscannerGetScanHarV2 GET /accounts/{account_id}/urlscanner/v2/har/{scan_id} Get URL scan's HAR
urlscannerGetScanScreenshotV2 GET /accounts/{account_id}/urlscanner/v2/screenshots/{scan_id}.png Get screenshot
urlscannerGetScanV2 GET /accounts/{account_id}/urlscanner/v2/result/{scan_id} Get URL scan
urlscannerSearchScansV2 GET /accounts/{account_id}/urlscanner/v2/search Search URL scans

urlscannerCreateScanBulkV2

BuiltList urlscannerCreateScanBulkV2(accountId, urlscannerCreateScanBulkV2RequestInner)

Bulk create URL Scans

Submit URLs to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/ and take into account scans submitted in bulk have lower priority and may take longer to finish.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String accountId = accountId_example; // String | Account ID.
final BuiltList<UrlscannerCreateScanBulkV2RequestInner> urlscannerCreateScanBulkV2RequestInner = ; // BuiltList<UrlscannerCreateScanBulkV2RequestInner> | 

try {
    final response = api.urlscannerCreateScanBulkV2(accountId, urlscannerCreateScanBulkV2RequestInner);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerCreateScanBulkV2: $e\n');
}

Parameters

Name Type Description Notes
accountId String Account ID.
urlscannerCreateScanBulkV2RequestInner BuiltList<UrlscannerCreateScanBulkV2RequestInner> [optional]

Return type

BuiltList<UrlscannerCreateScanBulkV2200ResponseInner>

Authorization

api_key, api_token, api_email

HTTP request headers

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

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

urlscannerCreateScanV2

UrlscannerCreateScanV2200Response urlscannerCreateScanV2(accountId, urlscannerCreateScanV2Request)

Create URL Scan

Submit a URL to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String accountId = accountId_example; // String | Account ID.
final UrlscannerCreateScanV2Request urlscannerCreateScanV2Request = ; // UrlscannerCreateScanV2Request | 

try {
    final response = api.urlscannerCreateScanV2(accountId, urlscannerCreateScanV2Request);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerCreateScanV2: $e\n');
}

Parameters

Name Type Description Notes
accountId String Account ID.
urlscannerCreateScanV2Request UrlscannerCreateScanV2Request [optional]

Return type

UrlscannerCreateScanV2200Response

Authorization

api_key, api_token, api_email

HTTP request headers

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

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

urlscannerGetResponseV2

String urlscannerGetResponseV2(responseId, accountId)

Get raw response

Returns the raw response of the network request. Find the response_id in the data.requests.response.hash.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String responseId = responseId_example; // String | Response hash.
final String accountId = accountId_example; // String | Account ID.

try {
    final response = api.urlscannerGetResponseV2(responseId, accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerGetResponseV2: $e\n');
}

Parameters

Name Type Description Notes
responseId String Response hash.
accountId String Account ID.

Return type

String

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json

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

urlscannerGetScanDomV2

String urlscannerGetScanDomV2(scanId, accountId)

Get URL scan's DOM

Returns a plain text response, with the scan's DOM content as rendered by Chrome.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String scanId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Scan UUID.
final String accountId = accountId_example; // String | Account ID.

try {
    final response = api.urlscannerGetScanDomV2(scanId, accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerGetScanDomV2: $e\n');
}

Parameters

Name Type Description Notes
scanId String Scan UUID.
accountId String Account ID.

Return type

String

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json

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

urlscannerGetScanHarV2

UrlscannerGetScanHar200ResponseResultHar urlscannerGetScanHarV2(scanId, accountId)

Get URL scan's HAR

Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String scanId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Scan UUID.
final String accountId = accountId_example; // String | Account ID.

try {
    final response = api.urlscannerGetScanHarV2(scanId, accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerGetScanHarV2: $e\n');
}

Parameters

Name Type Description Notes
scanId String Scan UUID.
accountId String Account ID.

Return type

UrlscannerGetScanHar200ResponseResultHar

Authorization

api_key, api_token, api_email

HTTP request headers

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

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

urlscannerGetScanScreenshotV2

String urlscannerGetScanScreenshotV2(scanId, accountId, resolution)

Get screenshot

Get scan's screenshot by resolution (desktop/mobile/tablet).

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String scanId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Scan UUID.
final String accountId = accountId_example; // String | Account ID.
final String resolution = resolution_example; // String | Target device type.

try {
    final response = api.urlscannerGetScanScreenshotV2(scanId, accountId, resolution);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerGetScanScreenshotV2: $e\n');
}

Parameters

Name Type Description Notes
scanId String Scan UUID.
accountId String Account ID.
resolution String Target device type. [optional] [default to 'desktop']

Return type

String

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/png, application/json

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

urlscannerGetScanV2

UrlscannerGetScanV2200Response urlscannerGetScanV2(scanId, accountId)

Get URL scan

Get URL scan by uuid

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String scanId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Scan UUID.
final String accountId = accountId_example; // String | Account ID.

try {
    final response = api.urlscannerGetScanV2(scanId, accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerGetScanV2: $e\n');
}

Parameters

Name Type Description Notes
scanId String Scan UUID.
accountId String Account ID.

Return type

UrlscannerGetScanV2200Response

Authorization

api_key, api_token, api_email

HTTP request headers

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

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

urlscannerSearchScansV2

UrlscannerSearchScansV2200Response urlscannerSearchScansV2(accountId, size, q)

Search URL scans

Use a subset of ElasticSearch Query syntax to filter scans. Some example queries:

- 'path:"/bundles/jquery.js"': Searches for scans who requested resources with the given path.
- 'page.asn:AS24940 AND hash:xxx': Websites hosted in AS24940 where a resource with the given hash was downloaded.
- 'page.domain:microsoft* AND verdicts.malicious:true AND NOT page.domain:microsoft.com': malicious scans whose hostname starts with "microsoft".
- 'apikey:me AND date:[2025-01 TO 2025-02]': my scans from 2025 January to 2025 February.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getURLScannerApi();
final String accountId = accountId_example; // String | Account ID.
final int size = 100; // int | Limit the number of objects in the response.
final String q = q_example; // String | Filter scans

try {
    final response = api.urlscannerSearchScansV2(accountId, size, q);
    print(response);
} catch on DioException (e) {
    print('Exception when calling URLScannerApi->urlscannerSearchScansV2: $e\n');
}

Parameters

Name Type Description Notes
accountId String Account ID.
size int Limit the number of objects in the response. [optional]
q String Filter scans [optional]

Return type

UrlscannerSearchScansV2200Response

Authorization

api_key, api_token, api_email

HTTP request headers

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

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