Skip to content

KeylessSSLForAZoneApi.md

Latest commit

 

History

History
279 lines (201 loc) · 12 KB

KeylessSSLForAZoneApi.md

File metadata and controls

279 lines (201 loc) · 12 KB

cloudflare_dart.api.KeylessSSLForAZoneApi

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
keylessSslForAZoneCreateKeylessSslConfiguration POST /zones/{zone_id}/keyless_certificates Create Keyless SSL Configuration
keylessSslForAZoneDeleteKeylessSslConfiguration DELETE /zones/{zone_id}/keyless_certificates/{keyless_certificate_id} Delete Keyless SSL Configuration
keylessSslForAZoneEditKeylessSslConfiguration PATCH /zones/{zone_id}/keyless_certificates/{keyless_certificate_id} Edit Keyless SSL Configuration
keylessSslForAZoneGetKeylessSslConfiguration GET /zones/{zone_id}/keyless_certificates/{keyless_certificate_id} Get Keyless SSL Configuration
keylessSslForAZoneListKeylessSslConfigurations GET /zones/{zone_id}/keyless_certificates List Keyless SSL Configurations

keylessSslForAZoneCreateKeylessSslConfiguration

TlsCertificatesAndHostnamesKeylessResponseSingle keylessSslForAZoneCreateKeylessSslConfiguration(zoneId, keylessSslForAZoneCreateKeylessSslConfigurationRequest)

Create Keyless SSL Configuration

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().getKeylessSSLForAZoneApi();
final String zoneId = zoneId_example; // String | 
final KeylessSslForAZoneCreateKeylessSslConfigurationRequest keylessSslForAZoneCreateKeylessSslConfigurationRequest = ; // KeylessSslForAZoneCreateKeylessSslConfigurationRequest | 

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

Parameters

Name Type Description Notes
zoneId String
keylessSslForAZoneCreateKeylessSslConfigurationRequest KeylessSslForAZoneCreateKeylessSslConfigurationRequest

Return type

TlsCertificatesAndHostnamesKeylessResponseSingle

Authorization

api_key, 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]

keylessSslForAZoneDeleteKeylessSslConfiguration

TlsCertificatesAndHostnamesKeylessResponseSingleId keylessSslForAZoneDeleteKeylessSslConfiguration(keylessCertificateId, zoneId)

Delete Keyless SSL Configuration

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().getKeylessSSLForAZoneApi();
final String keylessCertificateId = keylessCertificateId_example; // String | 
final String zoneId = zoneId_example; // String | 

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

Parameters

Name Type Description Notes
keylessCertificateId String
zoneId String

Return type

TlsCertificatesAndHostnamesKeylessResponseSingleId

Authorization

api_key, 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]

keylessSslForAZoneEditKeylessSslConfiguration

TlsCertificatesAndHostnamesKeylessResponseSingle keylessSslForAZoneEditKeylessSslConfiguration(keylessCertificateId, zoneId, keylessSslForAZoneEditKeylessSslConfigurationRequest)

Edit Keyless SSL Configuration

This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port.

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().getKeylessSSLForAZoneApi();
final String keylessCertificateId = keylessCertificateId_example; // String | 
final String zoneId = zoneId_example; // String | 
final KeylessSslForAZoneEditKeylessSslConfigurationRequest keylessSslForAZoneEditKeylessSslConfigurationRequest = ; // KeylessSslForAZoneEditKeylessSslConfigurationRequest | 

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

Parameters

Name Type Description Notes
keylessCertificateId String
zoneId String
keylessSslForAZoneEditKeylessSslConfigurationRequest KeylessSslForAZoneEditKeylessSslConfigurationRequest

Return type

TlsCertificatesAndHostnamesKeylessResponseSingle

Authorization

api_key, 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]

keylessSslForAZoneGetKeylessSslConfiguration

TlsCertificatesAndHostnamesKeylessResponseSingle keylessSslForAZoneGetKeylessSslConfiguration(keylessCertificateId, zoneId)

Get Keyless SSL Configuration

Get details for one Keyless SSL configuration.

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().getKeylessSSLForAZoneApi();
final String keylessCertificateId = keylessCertificateId_example; // String | 
final String zoneId = zoneId_example; // String | 

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

Parameters

Name Type Description Notes
keylessCertificateId String
zoneId String

Return type

TlsCertificatesAndHostnamesKeylessResponseSingle

Authorization

api_key, 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]

keylessSslForAZoneListKeylessSslConfigurations

TlsCertificatesAndHostnamesKeylessResponseCollection keylessSslForAZoneListKeylessSslConfigurations(zoneId)

List Keyless SSL Configurations

List all Keyless SSL configurations for a given zone.

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().getKeylessSSLForAZoneApi();
final String zoneId = zoneId_example; // String | 

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

Parameters

Name Type Description Notes
zoneId String

Return type

TlsCertificatesAndHostnamesKeylessResponseCollection

Authorization

api_key, 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]