Skip to content

RepositoryConnectionsApi.md

Latest commit

 

History

History
121 lines (86 loc) · 4.67 KB

RepositoryConnectionsApi.md

File metadata and controls

121 lines (86 loc) · 4.67 KB

cloudflare_dart.api.RepositoryConnectionsApi

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
deleteRepoConnection DELETE /accounts/{account_id}/builds/repos/connections/{repo_connection_uuid} Delete repository connection
upsertRepoConnection PUT /accounts/{account_id}/builds/repos/connections Create or update repository connection

deleteRepoConnection

BuildsAPIResponse deleteRepoConnection(accountId, repoConnectionUuid)

Delete repository connection

Remove a repository connection

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().getRepositoryConnectionsApi();
final String accountId = account-123; // String | Account identifier
final String repoConnectionUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Repository connection UUID

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

Parameters

Name Type Description Notes
accountId String Account identifier
repoConnectionUuid String Repository connection UUID

Return type

BuildsAPIResponse

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]

upsertRepoConnection

UpsertRepoConnection200Response upsertRepoConnection(accountId, buildsUpsertRepoConnectionRequest)

Create or update repository connection

Upsert a repository connection for CI/CD integration

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().getRepositoryConnectionsApi();
final String accountId = account-123; // String | Account identifier
final BuildsUpsertRepoConnectionRequest buildsUpsertRepoConnectionRequest = ; // BuildsUpsertRepoConnectionRequest | 

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

Parameters

Name Type Description Notes
accountId String Account identifier
buildsUpsertRepoConnectionRequest BuildsUpsertRepoConnectionRequest

Return type

UpsertRepoConnection200Response

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]