Skip to content

DomainsApi.md

Latest commit

 

History

History
318 lines (220 loc) · 9.06 KB

DomainsApi.md

File metadata and controls

318 lines (220 loc) · 9.06 KB

QuantClient\DomainsApi

All URIs are relative to https://dashboard.quantcdn.io, except if the operation defines another base path.

Method HTTP request Description
domainsCreate() POST /api/v2/organizations/{organization}/projects/{project}/domains Add a new domain
domainsDelete() DELETE /api/v2/organizations/{organization}/projects/{project}/domains/{domain} Delete a domain
domainsList() GET /api/v2/organizations/{organization}/projects/{project}/domains List all domains for a project
domainsRead() GET /api/v2/organizations/{organization}/projects/{project}/domains/{domain} Get details of a single domain
domainsRenew() POST /api/v2/organizations/{organization}/projects/{project}/domains/{domain}/renew Renew the SSL certificate for a domain

domainsCreate()

domainsCreate($organization, $project, $v2_domain_request): \QuantClient\Model\V2Domain

Add a new domain

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\DomainsApi(
    // 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
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$v2_domain_request = new \QuantClient\Model\V2DomainRequest(); // \QuantClient\Model\V2DomainRequest

try {
    $result = $apiInstance->domainsCreate($organization, $project, $v2_domain_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier
v2_domain_request \QuantClient\Model\V2DomainRequest

Return type

\QuantClient\Model\V2Domain

Authorization

BearerAuth

HTTP request headers

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

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

domainsDelete()

domainsDelete($organization, $project, $domain)

Delete a domain

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\DomainsApi(
    // 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
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$domain = 0000; // string | Domain id

try {
    $apiInstance->domainsDelete($organization, $project, $domain);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier
domain string Domain id

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

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

domainsList()

domainsList($organization, $project): \QuantClient\Model\V2Domain[]

List all domains for a project

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\DomainsApi(
    // 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
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier

try {
    $result = $apiInstance->domainsList($organization, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier

Return type

\QuantClient\Model\V2Domain[]

Authorization

BearerAuth

HTTP request headers

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

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

domainsRead()

domainsRead($organization, $project, $domain): \QuantClient\Model\V2Domain

Get details of a single domain

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\DomainsApi(
    // 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
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$domain = 0000; // string | Domain id

try {
    $result = $apiInstance->domainsRead($organization, $project, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsRead: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier
domain string Domain id

Return type

\QuantClient\Model\V2Domain

Authorization

BearerAuth

HTTP request headers

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

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

domainsRenew()

domainsRenew($organization, $project, $domain)

Renew the SSL certificate for a domain

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\DomainsApi(
    // 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
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$domain = 0000; // string | Domain id

try {
    $apiInstance->domainsRenew($organization, $project, $domain);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsRenew: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier
domain string Domain id

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

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