Skip to content

SSHAccessApi.md

Latest commit

 

History

History
70 lines (48 loc) · 2.27 KB

SSHAccessApi.md

File metadata and controls

70 lines (48 loc) · 2.27 KB

QuantClient\SSHAccessApi

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

Method HTTP request Description
getSshAccessCredentials() GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/ssh-access Get SSH access credentials for an environment

getSshAccessCredentials()

getSshAccessCredentials($organisation, $application, $environment): \QuantClient\Model\GetSshAccessCredentials200Response

Get SSH access credentials for 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\SSHAccessApi(
    // 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 {
    $result = $apiInstance->getSshAccessCredentials($organisation, $application, $environment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SSHAccessApi->getSshAccessCredentials: ', $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

\QuantClient\Model\GetSshAccessCredentials200Response

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]