OpenAPI\Client\ElementsConfigsApi

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

Method	HTTP request	Description
createElementsConfig()	POST /v2/elements/{proj_id}/{env_id}/config	Create Elements Config
deleteElementsConfig()	DELETE /v2/elements/{proj_id}/{env_id}/{elements_config_id}	Delete Elements Config
getElementsConfig()	GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}	Get Elements Config
getElementsConfigRuntime()	GET /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/runtime	Get Elements Config Runtime
getElementsTypeConfig()	GET /v2/elements/{proj_id}/{env_id}/{element_type}	Get Elements Type Config
listElementsConfigs()	GET /v2/elements/{proj_id}/{env_id}/config	List Elements Configs
updateElementsConfig()	PATCH /v2/elements/{proj_id}/{env_id}/config/{elements_config_id}	Update Elements Config
updateElementsTypePermissions()	PATCH /v2/elements/{proj_id}/{env_id}/{element_type}	Update Elements Type Permissions

`createElementsConfig()`

createElementsConfig($proj_id, $env_id, $elements_config_create): \OpenAPI\Client\Model\ElementsConfigRead

Create Elements Config

Creates a new elements_config under the active organization.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$elements_config_create = new \OpenAPI\Client\Model\ElementsConfigCreate(); // \OpenAPI\Client\Model\ElementsConfigCreate

try {
    $result = $apiInstance->createElementsConfig($proj_id, $env_id, $elements_config_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->createElementsConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
elements_config_create	\OpenAPI\Client\Model\ElementsConfigCreate

Return type

\OpenAPI\Client\Model\ElementsConfigRead

Authorization

HTTPBearer

HTTP request headers

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

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

`deleteElementsConfig()`

deleteElementsConfig($elements_config_id, $proj_id, $env_id)

Delete Elements Config

Deletes the elements_config and all its related data.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$elements_config_id = 'elements_config_id_example'; // string | Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").

try {
    $apiInstance->deleteElementsConfig($elements_config_id, $proj_id, $env_id);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->deleteElementsConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
elements_config_id	string	Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Return type

void (empty response body)

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getElementsConfig()`

getElementsConfig($proj_id, $env_id, $elements_config_id): \OpenAPI\Client\Model\ElementsConfigRead

Get Elements Config

Gets a single elements_config matching the given elements_config_id, if such elements_config exists.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$elements_config_id = 'elements_config_id_example'; // string | Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").

try {
    $result = $apiInstance->getElementsConfig($proj_id, $env_id, $elements_config_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->getElementsConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
elements_config_id	string	Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").

Return type

\OpenAPI\Client\Model\ElementsConfigRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getElementsConfigRuntime()`

getElementsConfigRuntime($proj_id, $env_id, $elements_config_id): \OpenAPI\Client\Model\ElementsConfigRuntimeRead

Get Elements Config Runtime

Gets a single elements_config matching the given elements_config_id, if such elements_config exists.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$elements_config_id = 'elements_config_id_example'; // string | Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").

try {
    $result = $apiInstance->getElementsConfigRuntime($proj_id, $env_id, $elements_config_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->getElementsConfigRuntime: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
elements_config_id	string	Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").

Return type

\OpenAPI\Client\Model\ElementsConfigRuntimeRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getElementsTypeConfig()`

getElementsTypeConfig($proj_id, $env_id, $element_type): \OpenAPI\Client\Model\ElementsEnvTypeRead

Get Elements Type Config

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$element_type = new \OpenAPI\Client\Model\ElementsType(); // ElementsType | Either the unique id of the elements_type, or the URL-friendly key of the elements_type (i.e: the \"slug\").

try {
    $result = $apiInstance->getElementsTypeConfig($proj_id, $env_id, $element_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->getElementsTypeConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
element_type	ElementsType	Either the unique id of the elements_type, or the URL-friendly key of the elements_type (i.e: the "slug").

Return type

\OpenAPI\Client\Model\ElementsEnvTypeRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`listElementsConfigs()`

listElementsConfigs($proj_id, $env_id, $page, $per_page): \OpenAPI\Client\Model\PaginatedResultElementsConfigRead

List Elements Configs

Lists all the elements_configs under the active organization.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$page = 1; // int | Page number of the results to fetch, starting at 1.
$per_page = 30; // int | The number of results per page (max 100).

try {
    $result = $apiInstance->listElementsConfigs($proj_id, $env_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->listElementsConfigs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
page	int	Page number of the results to fetch, starting at 1.	[optional] [default to 1]
per_page	int	The number of results per page (max 100).	[optional] [default to 30]

Return type

\OpenAPI\Client\Model\PaginatedResultElementsConfigRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateElementsConfig()`

updateElementsConfig($elements_config_id, $proj_id, $env_id, $elements_config_update): \OpenAPI\Client\Model\ElementsConfigRead

Update Elements Config

Updates the elements_config.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$elements_config_id = 'elements_config_id_example'; // string | Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the \"slug\").
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$elements_config_update = new \OpenAPI\Client\Model\ElementsConfigUpdate(); // \OpenAPI\Client\Model\ElementsConfigUpdate

try {
    $result = $apiInstance->updateElementsConfig($elements_config_id, $proj_id, $env_id, $elements_config_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->updateElementsConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
elements_config_id	string	Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
elements_config_update	\OpenAPI\Client\Model\ElementsConfigUpdate

Return type

\OpenAPI\Client\Model\ElementsConfigRead

Authorization

HTTPBearer

HTTP request headers

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

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

`updateElementsTypePermissions()`

updateElementsTypePermissions($element_type, $proj_id, $env_id, $elements_env_type_update): \OpenAPI\Client\Model\ElementsEnvTypeRead

Update Elements Type Permissions

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ElementsConfigsApi(
    // 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
);
$element_type = new \OpenAPI\Client\Model\ElementsType(); // ElementsType | Either the unique id of the elements_type, or the URL-friendly key of the elements_type (i.e: the \"slug\").
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$elements_env_type_update = new \OpenAPI\Client\Model\ElementsEnvTypeUpdate(); // \OpenAPI\Client\Model\ElementsEnvTypeUpdate

try {
    $result = $apiInstance->updateElementsTypePermissions($element_type, $proj_id, $env_id, $elements_env_type_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ElementsConfigsApi->updateElementsTypePermissions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
element_type	ElementsType	Either the unique id of the elements_type, or the URL-friendly key of the elements_type (i.e: the "slug").
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
elements_env_type_update	\OpenAPI\Client\Model\ElementsEnvTypeUpdate

Return type

\OpenAPI\Client\Model\ElementsEnvTypeRead

Authorization

HTTPBearer

HTTP request headers

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

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

Files

ElementsConfigsApi.md

Latest commit

History

ElementsConfigsApi.md

File metadata and controls

OpenAPI\Client\ElementsConfigsApi

createElementsConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteElementsConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

getElementsConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

getElementsConfigRuntime()

Example

Parameters

Return type

Authorization

HTTP request headers

getElementsTypeConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

listElementsConfigs()

Example

Parameters

Return type

Authorization

HTTP request headers

updateElementsConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

updateElementsTypePermissions()

Example

Parameters

Return type

Authorization

HTTP request headers

`createElementsConfig()`

`deleteElementsConfig()`

`getElementsConfig()`

`getElementsConfigRuntime()`

`getElementsTypeConfig()`

`listElementsConfigs()`

`updateElementsConfig()`

`updateElementsTypePermissions()`