Skip to content

Latest commit

 

History

History
385 lines (256 loc) · 10.4 KB

CloudsyncCredentialsApi.md

File metadata and controls

385 lines (256 loc) · 10.4 KB
Raw

RMoore\Truenas\CloudsyncCredentialsApi

All URIs are relative to https://truenas.local/api/v2.0.

Method HTTP request Description
cloudsyncCredentialsGet() GET /cloudsync/credentials
cloudsyncCredentialsIdIdDelete() DELETE /cloudsync/credentials/id/{id}
cloudsyncCredentialsIdIdGet() GET /cloudsync/credentials/id/{id}
cloudsyncCredentialsIdIdPut() PUT /cloudsync/credentials/id/{id}
cloudsyncCredentialsPost() POST /cloudsync/credentials
cloudsyncCredentialsVerifyPost() POST /cloudsync/credentials/verify

cloudsyncCredentialsGet()

cloudsyncCredentialsGet($limit, $offset, $count, $sort)

query-options.extra can be specified as query parameters with prefixing them with extra. prefix. For example, extra.retrieve_properties=false will pass retrieve_properties as an extra argument to pool/dataset endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\CloudsyncCredentialsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 56; // int
$offset = 56; // int
$count = True; // bool
$sort = 'sort_example'; // string

try {
    $apiInstance->cloudsyncCredentialsGet($limit, $offset, $count, $sort);
} catch (Exception $e) {
    echo 'Exception when calling CloudsyncCredentialsApi->cloudsyncCredentialsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
limit int [optional]
offset int [optional]
count bool [optional]
sort string [optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

cloudsyncCredentialsIdIdDelete()

cloudsyncCredentialsIdIdDelete($id)

Delete Cloud Sync Credentials of id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\CloudsyncCredentialsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int

try {
    $apiInstance->cloudsyncCredentialsIdIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling CloudsyncCredentialsApi->cloudsyncCredentialsIdIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

cloudsyncCredentialsIdIdGet()

cloudsyncCredentialsIdIdGet($id)

query-options.extra can be specified as query parameters with prefixing them with extra. prefix. For example, extra.retrieve_properties=false will pass retrieve_properties as an extra argument to pool/dataset endpoint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\CloudsyncCredentialsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int

try {
    $apiInstance->cloudsyncCredentialsIdIdGet($id);
} catch (Exception $e) {
    echo 'Exception when calling CloudsyncCredentialsApi->cloudsyncCredentialsIdIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

cloudsyncCredentialsIdIdPut()

cloudsyncCredentialsIdIdPut($id)

Update Cloud Sync Credentials of id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\CloudsyncCredentialsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int

try {
    $apiInstance->cloudsyncCredentialsIdIdPut($id);
} catch (Exception $e) {
    echo 'Exception when calling CloudsyncCredentialsApi->cloudsyncCredentialsIdIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

cloudsyncCredentialsPost()

cloudsyncCredentialsPost($cloudsync_credentials_create0)

Create Cloud Sync Credentials. attributes is a dictionary of valid values which will be used to authorize with the provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\CloudsyncCredentialsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$cloudsync_credentials_create0 = new \RMoore\Truenas\Model\CloudsyncCredentialsCreate0(); // \RMoore\Truenas\Model\CloudsyncCredentialsCreate0

try {
    $apiInstance->cloudsyncCredentialsPost($cloudsync_credentials_create0);
} catch (Exception $e) {
    echo 'Exception when calling CloudsyncCredentialsApi->cloudsyncCredentialsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
cloudsync_credentials_create0 \RMoore\Truenas\Model\CloudsyncCredentialsCreate0 [optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

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

cloudsyncCredentialsVerifyPost()

cloudsyncCredentialsVerifyPost($cloudsync_credentials_verify0)

Verify if attributes provided for provider are authorized by the provider.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basic
$config = RMoore\Truenas\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RMoore\Truenas\Api\CloudsyncCredentialsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$cloudsync_credentials_verify0 = new \RMoore\Truenas\Model\CloudsyncCredentialsVerify0(); // \RMoore\Truenas\Model\CloudsyncCredentialsVerify0

try {
    $apiInstance->cloudsyncCredentialsVerifyPost($cloudsync_credentials_verify0);
} catch (Exception $e) {
    echo 'Exception when calling CloudsyncCredentialsApi->cloudsyncCredentialsVerifyPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
cloudsync_credentials_verify0 \RMoore\Truenas\Model\CloudsyncCredentialsVerify0 [optional]

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

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