QuantClient\KVApi

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

Method	HTTP request	Description
kVCreate()	POST /api/v2/organizations/{organization}/projects/{project}/kv	Add a kv store
kVDelete()	DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}	Delete a kv store
kVItemsCreate()	POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items	Add an item to a kv store
kVItemsDelete()	DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}	Delete an item from a kv store
kVItemsList()	GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items	List items in a kv store
kVItemsShow()	GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}	Get an item from a kv store
kVItemsUpdate()	PUT /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}	Update an item in a kv store
kVLinkToProject()	POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/link	Link a KV store to another project
kVList()	GET /api/v2/organizations/{organization}/projects/{project}/kv	List key-value stores
kVShow()	GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}	Get a kv store
kVUnlinkFromProject()	DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/link	Unlink a KV store from this project

`kVCreate()`

kVCreate($organization, $project, $v2_store_request): \QuantClient\Model\V2Store

Add a kv store

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\KVApi(
    // 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_store_request = new \QuantClient\Model\V2StoreRequest(); // \QuantClient\Model\V2StoreRequest

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

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
v2_store_request	\QuantClient\Model\V2StoreRequest

Return type

\QuantClient\Model\V2Store

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]

`kVDelete()`

kVDelete($organization, $project, $store_id)

Delete a kv store

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\KVApi(
    // 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
$store_id = 0000; // string

try {
    $apiInstance->kVDelete($organization, $project, $store_id);
} catch (Exception $e) {
    echo 'Exception when calling KVApi->kVDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

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]

`kVItemsCreate()`

kVItemsCreate($organization, $project, $store_id, $v2_store_item_request): \QuantClient\Model\KVItemsCreate200Response

Add an item to a kv store

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\KVApi(
    // 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
$store_id = 0000; // string
$v2_store_item_request = new \QuantClient\Model\V2StoreItemRequest(); // \QuantClient\Model\V2StoreItemRequest

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

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
store_id	string
v2_store_item_request	\QuantClient\Model\V2StoreItemRequest

Return type

\QuantClient\Model\KVItemsCreate200Response

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]

`kVItemsDelete()`

kVItemsDelete($organization, $project, $store_id, $key): \QuantClient\Model\KVItemsDelete200Response

Delete an item from a kv store

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\KVApi(
    // 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
$store_id = 0000; // string
$key = 'key_example'; // string

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

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
store_id	string
key	string

Return type

\QuantClient\Model\KVItemsDelete200Response

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]

`kVItemsList()`

kVItemsList($organization, $project, $store_id, $cursor, $limit, $search, $include_values): \QuantClient\Model\V2StoreItemsListResponse

List items in a kv store

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\KVApi(
    // 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
$store_id = 0000; // string
$cursor = 'cursor_example'; // string | Cursor for pagination
$limit = 10; // int | Number of items to return
$search = 'search_example'; // string | Search filter for keys
$include_values = false; // bool | Include values in the response. Secret values will be redacted as '[ENCRYPTED]' for security.

try {
    $result = $apiInstance->kVItemsList($organization, $project, $store_id, $cursor, $limit, $search, $include_values);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KVApi->kVItemsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
organization	string	Organization identifier
project	string	Project identifier
store_id	string
cursor	string	Cursor for pagination	[optional]
limit	int	Number of items to return	[optional] [default to 10]
search	string	Search filter for keys	[optional]
include_values	bool	Include values in the response. Secret values will be redacted as '[ENCRYPTED]' for security.	[optional] [default to false]

Return type

\QuantClient\Model\V2StoreItemsListResponse

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]

`kVItemsShow()`

kVItemsShow($organization, $project, $store_id, $key): \QuantClient\Model\KVItemsShow200Response

Get an item from a kv store

Retrieves an item from the KV store. Security Note: If the item was stored as a secret (secret=true), the value will be redacted and returned as '[ENCRYPTED]' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction.

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\KVApi(
    // 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
$store_id = 0000; // string
$key = 'key_example'; // string

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

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
store_id	string
key	string

Return type

\QuantClient\Model\KVItemsShow200Response

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]

`kVItemsUpdate()`

kVItemsUpdate($organization, $project, $store_id, $key, $v2_store_item_update_request): \QuantClient\Model\KVItemsCreate200Response

Update an item in a kv store

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\KVApi(
    // 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
$store_id = 0000; // string
$key = 'key_example'; // string
$v2_store_item_update_request = new \QuantClient\Model\V2StoreItemUpdateRequest(); // \QuantClient\Model\V2StoreItemUpdateRequest

try {
    $result = $apiInstance->kVItemsUpdate($organization, $project, $store_id, $key, $v2_store_item_update_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KVApi->kVItemsUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
store_id	string
key	string
v2_store_item_update_request	\QuantClient\Model\V2StoreItemUpdateRequest

Return type

\QuantClient\Model\KVItemsCreate200Response

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]

`kVLinkToProject()`

kVLinkToProject($organization, $project, $store_id, $kv_link_to_project_request): \QuantClient\Model\KVLinkToProject200Response

Link a KV store to another project

Share a KV store from the source project with a target project. The store will be accessible in the target 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\KVApi(
    // 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 | Source project identifier
$store_id = store-123; // string | KV store identifier
$kv_link_to_project_request = new \QuantClient\Model\KVLinkToProjectRequest(); // \QuantClient\Model\KVLinkToProjectRequest

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

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Source project identifier
store_id	string	KV store identifier
kv_link_to_project_request	\QuantClient\Model\KVLinkToProjectRequest

Return type

\QuantClient\Model\KVLinkToProject200Response

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]

`kVList()`

kVList($organization, $project): \QuantClient\Model\V2Store[]

List key-value stores

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\KVApi(
    // 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->kVList($organization, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KVApi->kVList: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\QuantClient\Model\V2Store[]

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]

`kVShow()`

kVShow($organization, $project, $store_id): \QuantClient\Model\V2Store

Get a kv store

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\KVApi(
    // 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
$store_id = 0000; // string

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

Parameters

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

Return type

\QuantClient\Model\V2Store

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]

`kVUnlinkFromProject()`

kVUnlinkFromProject($organization, $project, $store_id): \QuantClient\Model\KVLinkToProject200Response

Unlink a KV store from this project

Remove access to a linked KV store from this project. The store must be linked (not owned by this 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\KVApi(
    // 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
$store_id = store-123; // string | KV store identifier

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

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
store_id	string	KV store identifier

Return type

\QuantClient\Model\KVLinkToProject200Response

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]

Uh oh!

FilesExpand file tree

KVApi.md

Latest commit

History

KVApi.md

File metadata and controls

QuantClient\KVApi

kVCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

kVDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

kVItemsCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

kVItemsDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

kVItemsList()

Example

Parameters

Return type

Authorization

HTTP request headers

kVItemsShow()

Example

Parameters

Return type

Authorization

HTTP request headers

kVItemsUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

kVLinkToProject()

Example

Parameters

Return type

Authorization

HTTP request headers

kVList()

Example

Parameters

Return type

Authorization

HTTP request headers

kVShow()

Example

Parameters

Return type

Authorization

HTTP request headers

kVUnlinkFromProject()

Example

Parameters

Return type

Authorization

HTTP request headers

`kVCreate()`

`kVDelete()`

`kVItemsCreate()`

`kVItemsDelete()`

`kVItemsList()`

`kVItemsShow()`

`kVItemsUpdate()`

`kVLinkToProject()`

`kVList()`

`kVShow()`

`kVUnlinkFromProject()`