Skip to content

ContainersApi.md

Latest commit

 

History

History
135 lines (94 loc) · 4.19 KB

ContainersApi.md

File metadata and controls

135 lines (94 loc) · 4.19 KB

QuantClient\ContainersApi

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

Method HTTP request Description
listContainers() GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers Get the containers in an environment
updateContainer() PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers/{container} Update a container in an environment

listContainers()

listContainers($organisation, $application, $environment)

Get the containers in an environment

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\ContainersApi(
    // 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
);
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID

try {
    $apiInstance->listContainers($organisation, $application, $environment);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->listContainers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organisation string The organisation ID
application string The application ID
environment string The environment ID

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

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

updateContainer()

updateContainer($organisation, $application, $environment, $container, $container2)

Update a container in an environment

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\ContainersApi(
    // 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
);
$organisation = test-org; // string | The organisation ID
$application = test-app; // string | The application ID
$environment = test-env; // string | The environment ID
$container = test-container; // string | The container ID
$container2 = new \QuantClient\Model\Container(); // \QuantClient\Model\Container

try {
    $apiInstance->updateContainer($organisation, $application, $environment, $container, $container2);
} catch (Exception $e) {
    echo 'Exception when calling ContainersApi->updateContainer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organisation string The organisation ID
application string The application ID
environment string The environment ID
container string The container ID
container2 \QuantClient\Model\Container

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

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