Skip to content

Latest commit

 

History

History
198 lines (134 loc) · 6 KB

ApiKeysApi.md

File metadata and controls

198 lines (134 loc) · 6 KB

OpenAPI\Client\ApiKeysApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
apiKeysCreateApiKey() POST /api/manage/v1/ApiKeys Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
apiKeysDeleteApiKey() DELETE /api/manage/v1/ApiKeys Delete an apikey
apiKeysGetApiKeys() GET /api/manage/v1/ApiKeys Returns list with all apikeys of current user

apiKeysCreateApiKey()

apiKeysCreateApiKey($create_api_key_vm): \OpenAPI\Client\cloud\fastreport\model\ApiKeyVM

Create a new apikey, 5 apikeys for user. Hardcoded for ddos.

Example

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


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

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


$apiInstance = new OpenAPI\Client\Api\ApiKeysApi(
    // 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
);
$create_api_key_vm = new \OpenAPI\Client\cloud\fastreport\model\CreateApiKeyVM(); // \OpenAPI\Client\cloud\fastreport\model\CreateApiKeyVM

try {
    $result = $apiInstance->apiKeysCreateApiKey($create_api_key_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->apiKeysCreateApiKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
create_api_key_vm \OpenAPI\Client\cloud\fastreport\model\CreateApiKeyVM

Return type

\OpenAPI\Client\cloud\fastreport\model\ApiKeyVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

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

apiKeysDeleteApiKey()

apiKeysDeleteApiKey($delete_api_key_vm): \OpenAPI\Client\cloud\fastreport\model\ApiKeyVM

Delete an apikey

Example

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


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

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


$apiInstance = new OpenAPI\Client\Api\ApiKeysApi(
    // 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
);
$delete_api_key_vm = new \OpenAPI\Client\cloud\fastreport\model\DeleteApiKeyVM(); // \OpenAPI\Client\cloud\fastreport\model\DeleteApiKeyVM

try {
    $result = $apiInstance->apiKeysDeleteApiKey($delete_api_key_vm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiKeysApi->apiKeysDeleteApiKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
delete_api_key_vm \OpenAPI\Client\cloud\fastreport\model\DeleteApiKeyVM

Return type

\OpenAPI\Client\cloud\fastreport\model\ApiKeyVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

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

apiKeysGetApiKeys()

apiKeysGetApiKeys(): \OpenAPI\Client\cloud\fastreport\model\ApiKeysVM

Returns list with all apikeys of current user

Always work, it should make only 200 response (except if user is not authorized).

Example

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


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

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


$apiInstance = new OpenAPI\Client\Api\ApiKeysApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\cloud\fastreport\model\ApiKeysVM

Authorization

ApiKey, JWT

HTTP request headers

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

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