Skip to content

Latest commit

 

History

History
1411 lines (1016 loc) · 60.1 KB

File metadata and controls

1411 lines (1016 loc) · 60.1 KB

cloudflare_dart.api.DevicesApi

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
devicesCreateDeviceSettingsPolicy POST /accounts/{account_id}/devices/policy Create a device settings profile
devicesDeleteDeviceSettingsPolicy DELETE /accounts/{account_id}/devices/policy/{policy_id} Delete a device settings profile
devicesDeviceDetails GET /accounts/{account_id}/devices/{device_id} Get device (deprecated)
devicesGetDefaultDeviceSettingsPolicy GET /accounts/{account_id}/devices/policy Get the default device settings profile
devicesGetDeviceSettingsPolicyById GET /accounts/{account_id}/devices/policy/{policy_id} Get device settings profile by ID
devicesGetLocalDomainFallbackList GET /accounts/{account_id}/devices/policy/fallback_domains Get your Local Domain Fallback list
devicesGetLocalDomainFallbackListForADeviceSettingsPolicy GET /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains Get the Local Domain Fallback list for a device settings profile
devicesGetPolicyCertificates GET /zones/{zone_id}/devices/policy/certificates Get device certificate provisioning status
devicesGetSplitTunnelExcludeList GET /accounts/{account_id}/devices/policy/exclude Get the Split Tunnel exclude list
devicesGetSplitTunnelExcludeListForADeviceSettingsPolicy GET /accounts/{account_id}/devices/policy/{policy_id}/exclude Get the Split Tunnel exclude list for a device settings profile
devicesGetSplitTunnelIncludeList GET /accounts/{account_id}/devices/policy/include Get the Split Tunnel include list
devicesGetSplitTunnelIncludeListForADeviceSettingsPolicy GET /accounts/{account_id}/devices/policy/{policy_id}/include Get the Split Tunnel include list for a device settings profile
devicesListAdminOverrideCodeForDevice GET /accounts/{account_id}/devices/{device_id}/override_codes Get override codes (deprecated)
devicesListDeviceSettingsPolicies GET /accounts/{account_id}/devices/policies List device settings profiles
devicesListDevices GET /accounts/{account_id}/devices List devices (deprecated)
devicesRevokeDevices POST /accounts/{account_id}/devices/revoke Revoke devices (deprecated)
devicesSetLocalDomainFallbackList PUT /accounts/{account_id}/devices/policy/fallback_domains Set your Local Domain Fallback list
devicesSetLocalDomainFallbackListForADeviceSettingsPolicy PUT /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains Set the Local Domain Fallback list for a device settings profile
devicesSetSplitTunnelExcludeList PUT /accounts/{account_id}/devices/policy/exclude Set the Split Tunnel exclude list
devicesSetSplitTunnelExcludeListForADeviceSettingsPolicy PUT /accounts/{account_id}/devices/policy/{policy_id}/exclude Set the Split Tunnel exclude list for a device settings profile
devicesSetSplitTunnelIncludeList PUT /accounts/{account_id}/devices/policy/include Set the Split Tunnel include list
devicesSetSplitTunnelIncludeListForADeviceSettingsPolicy PUT /accounts/{account_id}/devices/policy/{policy_id}/include Set the Split Tunnel include list for a device settings profile
devicesUnrevokeDevices POST /accounts/{account_id}/devices/unrevoke Unrevoke devices (deprecated)
devicesUpdateDefaultDeviceSettingsPolicy PATCH /accounts/{account_id}/devices/policy Update the default device settings profile
devicesUpdateDeviceSettingsPolicy PATCH /accounts/{account_id}/devices/policy/{policy_id} Update a device settings profile
devicesUpdatePolicyCertificates PATCH /zones/{zone_id}/devices/policy/certificates Update device certificate provisioning status

devicesCreateDeviceSettingsPolicy

TeamsDevicesDeviceSettingsResponse devicesCreateDeviceSettingsPolicy(accountId, devicesCreateDeviceSettingsPolicyRequest)

Create a device settings profile

Creates a device settings profile to be applied to certain devices matching the criteria.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final DevicesCreateDeviceSettingsPolicyRequest devicesCreateDeviceSettingsPolicyRequest = ; // DevicesCreateDeviceSettingsPolicyRequest | 

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

Parameters

Name Type Description Notes
accountId JsonObject
devicesCreateDeviceSettingsPolicyRequest DevicesCreateDeviceSettingsPolicyRequest

Return type

TeamsDevicesDeviceSettingsResponse

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]

devicesDeleteDeviceSettingsPolicy

TeamsDevicesDeviceSettingsResponseCollection devicesDeleteDeviceSettingsPolicy(policyId, accountId)

Delete a device settings profile

Deletes a device settings profile and fetches a list of the remaining profiles for an account.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject

Return type

TeamsDevicesDeviceSettingsResponseCollection

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]

devicesDeviceDetails

TeamsDevicesDeviceResponse devicesDeviceDetails(deviceId, accountId)

Get device (deprecated)

Fetches a single WARP device. Not supported when multi-user mode is enabled for the account. Deprecated: please use one of the following endpoints instead: - GET /accounts/{account_id}/devices/physical-devices/{device_id} - GET /accounts/{account_id}/devices/registrations/{registration_id}

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().getDevicesApi();
final String deviceId = deviceId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
deviceId String
accountId JsonObject

Return type

TeamsDevicesDeviceResponse

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]

devicesGetDefaultDeviceSettingsPolicy

TeamsDevicesDefaultDeviceSettingsResponse devicesGetDefaultDeviceSettingsPolicy(accountId)

Get the default device settings profile

Fetches the default device settings profile for an account.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
accountId JsonObject

Return type

TeamsDevicesDefaultDeviceSettingsResponse

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]

devicesGetDeviceSettingsPolicyById

TeamsDevicesDeviceSettingsResponse devicesGetDeviceSettingsPolicyById(policyId, accountId)

Get device settings profile by ID

Fetches a device settings profile by ID.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject

Return type

TeamsDevicesDeviceSettingsResponse

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]

devicesGetLocalDomainFallbackList

TeamsDevicesFallbackDomainResponseCollection devicesGetLocalDomainFallbackList(accountId)

Get your Local Domain Fallback list

Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
accountId JsonObject

Return type

TeamsDevicesFallbackDomainResponseCollection

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]

devicesGetLocalDomainFallbackListForADeviceSettingsPolicy

TeamsDevicesFallbackDomainResponseCollection devicesGetLocalDomainFallbackListForADeviceSettingsPolicy(policyId, accountId)

Get the Local Domain Fallback list for a device settings profile

Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject

Return type

TeamsDevicesFallbackDomainResponseCollection

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]

devicesGetPolicyCertificates

TeamsDevicesDevicesPolicyCertificatesSingle devicesGetPolicyCertificates(zoneId)

Get device certificate provisioning status

Fetches device certificate provisioning.

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().getDevicesApi();
final JsonObject zoneId = ; // JsonObject | 

try {
    final response = api.devicesGetPolicyCertificates(zoneId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DevicesApi->devicesGetPolicyCertificates: $e\n');
}

Parameters

Name Type Description Notes
zoneId JsonObject

Return type

TeamsDevicesDevicesPolicyCertificatesSingle

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]

devicesGetSplitTunnelExcludeList

TeamsDevicesSplitTunnelResponseCollection devicesGetSplitTunnelExcludeList(accountId)

Get the Split Tunnel exclude list

Fetches the list of routes excluded from the WARP client's tunnel.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
accountId JsonObject

Return type

TeamsDevicesSplitTunnelResponseCollection

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]

devicesGetSplitTunnelExcludeListForADeviceSettingsPolicy

TeamsDevicesSplitTunnelResponseCollection devicesGetSplitTunnelExcludeListForADeviceSettingsPolicy(policyId, accountId)

Get the Split Tunnel exclude list for a device settings profile

Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject

Return type

TeamsDevicesSplitTunnelResponseCollection

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]

devicesGetSplitTunnelIncludeList

TeamsDevicesSplitTunnelIncludeResponseCollection devicesGetSplitTunnelIncludeList(accountId)

Get the Split Tunnel include list

Fetches the list of routes included in the WARP client's tunnel.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
accountId JsonObject

Return type

TeamsDevicesSplitTunnelIncludeResponseCollection

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]

devicesGetSplitTunnelIncludeListForADeviceSettingsPolicy

TeamsDevicesSplitTunnelIncludeResponseCollection devicesGetSplitTunnelIncludeListForADeviceSettingsPolicy(policyId, accountId)

Get the Split Tunnel include list for a device settings profile

Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject

Return type

TeamsDevicesSplitTunnelIncludeResponseCollection

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]

devicesListAdminOverrideCodeForDevice

TeamsDevicesOverrideCodesResponse devicesListAdminOverrideCodeForDevice(deviceId, accountId)

Get override codes (deprecated)

Fetches a one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration. Not supported when multi-user mode is enabled for the account. Deprecated: please use GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes instead.

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().getDevicesApi();
final String deviceId = deviceId_example; // String | 
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
deviceId String
accountId JsonObject

Return type

TeamsDevicesOverrideCodesResponse

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]

devicesListDeviceSettingsPolicies

TeamsDevicesDeviceSettingsResponseCollection devicesListDeviceSettingsPolicies(accountId)

List device settings profiles

Fetches a list of the device settings profiles for an account.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
accountId JsonObject

Return type

TeamsDevicesDeviceSettingsResponseCollection

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]

devicesListDevices

TeamsDevicesDevicesResponse devicesListDevices(accountId)

List devices (deprecated)

List WARP devices. Not supported when multi-user mode is enabled for the account. Deprecated: please use one of the following endpoints instead: - GET /accounts/{account_id}/devices/physical-devices - GET /accounts/{account_id}/devices/registrations

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 

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

Parameters

Name Type Description Notes
accountId JsonObject

Return type

TeamsDevicesDevicesResponse

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]

devicesRevokeDevices

TeamsDevicesApiResponseSingle devicesRevokeDevices(accountId, requestBody)

Revoke devices (deprecated)

Revokes a list of devices. Not supported when multi-user mode is enabled. Deprecated: please use POST /accounts/{account_id}/devices/registrations/revoke instead.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final BuiltList<String> requestBody = ; // BuiltList<String> | 

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

Parameters

Name Type Description Notes
accountId JsonObject
requestBody BuiltList<String>

Return type

TeamsDevicesApiResponseSingle

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]

devicesSetLocalDomainFallbackList

TeamsDevicesFallbackDomainResponseCollection devicesSetLocalDomainFallbackList(accountId, teamsDevicesFallbackDomain)

Set your Local Domain Fallback list

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final BuiltList<TeamsDevicesFallbackDomain> teamsDevicesFallbackDomain = ; // BuiltList<TeamsDevicesFallbackDomain> | 

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

Parameters

Name Type Description Notes
accountId JsonObject
teamsDevicesFallbackDomain BuiltList<TeamsDevicesFallbackDomain>

Return type

TeamsDevicesFallbackDomainResponseCollection

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]

devicesSetLocalDomainFallbackListForADeviceSettingsPolicy

TeamsDevicesFallbackDomainResponseCollection devicesSetLocalDomainFallbackListForADeviceSettingsPolicy(policyId, accountId, teamsDevicesFallbackDomain)

Set the Local Domain Fallback list for a device settings profile

Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 
final BuiltList<TeamsDevicesFallbackDomain> teamsDevicesFallbackDomain = ; // BuiltList<TeamsDevicesFallbackDomain> | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject
teamsDevicesFallbackDomain BuiltList<TeamsDevicesFallbackDomain>

Return type

TeamsDevicesFallbackDomainResponseCollection

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]

devicesSetSplitTunnelExcludeList

TeamsDevicesSplitTunnelResponseCollection devicesSetSplitTunnelExcludeList(accountId, teamsDevicesSplitTunnel)

Set the Split Tunnel exclude list

Sets the list of routes excluded from the WARP client's tunnel.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final BuiltList<TeamsDevicesSplitTunnel> teamsDevicesSplitTunnel = ; // BuiltList<TeamsDevicesSplitTunnel> | 

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

Parameters

Name Type Description Notes
accountId JsonObject
teamsDevicesSplitTunnel BuiltList<TeamsDevicesSplitTunnel>

Return type

TeamsDevicesSplitTunnelResponseCollection

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]

devicesSetSplitTunnelExcludeListForADeviceSettingsPolicy

TeamsDevicesSplitTunnelResponseCollection devicesSetSplitTunnelExcludeListForADeviceSettingsPolicy(policyId, accountId, teamsDevicesSplitTunnel)

Set the Split Tunnel exclude list for a device settings profile

Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 
final BuiltList<TeamsDevicesSplitTunnel> teamsDevicesSplitTunnel = ; // BuiltList<TeamsDevicesSplitTunnel> | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject
teamsDevicesSplitTunnel BuiltList<TeamsDevicesSplitTunnel>

Return type

TeamsDevicesSplitTunnelResponseCollection

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]

devicesSetSplitTunnelIncludeList

TeamsDevicesSplitTunnelIncludeResponseCollection devicesSetSplitTunnelIncludeList(accountId, teamsDevicesSplitTunnelInclude)

Set the Split Tunnel include list

Sets the list of routes included in the WARP client's tunnel.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final BuiltList<TeamsDevicesSplitTunnelInclude> teamsDevicesSplitTunnelInclude = ; // BuiltList<TeamsDevicesSplitTunnelInclude> | 

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

Parameters

Name Type Description Notes
accountId JsonObject
teamsDevicesSplitTunnelInclude BuiltList<TeamsDevicesSplitTunnelInclude>

Return type

TeamsDevicesSplitTunnelIncludeResponseCollection

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]

devicesSetSplitTunnelIncludeListForADeviceSettingsPolicy

TeamsDevicesSplitTunnelIncludeResponseCollection devicesSetSplitTunnelIncludeListForADeviceSettingsPolicy(policyId, accountId, teamsDevicesSplitTunnelInclude)

Set the Split Tunnel include list for a device settings profile

Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 
final BuiltList<TeamsDevicesSplitTunnelInclude> teamsDevicesSplitTunnelInclude = ; // BuiltList<TeamsDevicesSplitTunnelInclude> | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject
teamsDevicesSplitTunnelInclude BuiltList<TeamsDevicesSplitTunnelInclude>

Return type

TeamsDevicesSplitTunnelIncludeResponseCollection

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]

devicesUnrevokeDevices

TeamsDevicesApiResponseSingle devicesUnrevokeDevices(accountId, requestBody)

Unrevoke devices (deprecated)

Unrevokes a list of devices. Not supported when multi-user mode is enabled. Deprecated: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final BuiltList<String> requestBody = ; // BuiltList<String> | 

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

Parameters

Name Type Description Notes
accountId JsonObject
requestBody BuiltList<String>

Return type

TeamsDevicesApiResponseSingle

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]

devicesUpdateDefaultDeviceSettingsPolicy

TeamsDevicesDefaultDeviceSettingsResponse devicesUpdateDefaultDeviceSettingsPolicy(accountId, devicesUpdateDefaultDeviceSettingsPolicyRequest)

Update the default device settings profile

Updates the default device settings profile for an account.

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().getDevicesApi();
final JsonObject accountId = ; // JsonObject | 
final DevicesUpdateDefaultDeviceSettingsPolicyRequest devicesUpdateDefaultDeviceSettingsPolicyRequest = ; // DevicesUpdateDefaultDeviceSettingsPolicyRequest | 

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

Parameters

Name Type Description Notes
accountId JsonObject
devicesUpdateDefaultDeviceSettingsPolicyRequest DevicesUpdateDefaultDeviceSettingsPolicyRequest

Return type

TeamsDevicesDefaultDeviceSettingsResponse

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]

devicesUpdateDeviceSettingsPolicy

TeamsDevicesDeviceSettingsResponse devicesUpdateDeviceSettingsPolicy(policyId, accountId, devicesUpdateDeviceSettingsPolicyRequest)

Update a device settings profile

Updates a configured device settings profile.

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().getDevicesApi();
final String policyId = policyId_example; // String | 
final JsonObject accountId = ; // JsonObject | 
final DevicesUpdateDeviceSettingsPolicyRequest devicesUpdateDeviceSettingsPolicyRequest = ; // DevicesUpdateDeviceSettingsPolicyRequest | 

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

Parameters

Name Type Description Notes
policyId String
accountId JsonObject
devicesUpdateDeviceSettingsPolicyRequest DevicesUpdateDeviceSettingsPolicyRequest

Return type

TeamsDevicesDeviceSettingsResponse

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]

devicesUpdatePolicyCertificates

TeamsDevicesDevicesPolicyCertificatesSingle devicesUpdatePolicyCertificates(zoneId, teamsDevicesDevicesPolicyCertificates)

Update device certificate provisioning status

Enable Zero Trust Clients to provision a certificate, containing a x509 subject, and referenced by Access device posture policies when the client visits MTLS protected domains. This facilitates device posture without a WARP session.

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().getDevicesApi();
final JsonObject zoneId = ; // JsonObject | 
final TeamsDevicesDevicesPolicyCertificates teamsDevicesDevicesPolicyCertificates = ; // TeamsDevicesDevicesPolicyCertificates | 

try {
    final response = api.devicesUpdatePolicyCertificates(zoneId, teamsDevicesDevicesPolicyCertificates);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DevicesApi->devicesUpdatePolicyCertificates: $e\n');
}

Parameters

Name Type Description Notes
zoneId JsonObject
teamsDevicesDevicesPolicyCertificates TeamsDevicesDevicesPolicyCertificates

Return type

TeamsDevicesDevicesPolicyCertificatesSingle

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]