OpenAPI\Client\SecretsApi

All URIs are relative to https://api.contabo.com, except if the operation defines another base path.

Method	HTTP request	Description
createSecret()	POST /v1/secrets	Create a new secret
deleteSecret()	DELETE /v1/secrets/{secretId}	Delete existing secret by id
retrieveSecret()	GET /v1/secrets/{secretId}	Get specific secret by id
retrieveSecretList()	GET /v1/secrets	List secrets
updateSecret()	PATCH /v1/secrets/{secretId}	Update specific secret by id

`createSecret()`

createSecret($x_request_id, $create_secret_request, $x_trace_id): \OpenAPI\Client\Model\CreateSecretResponse

Create a new secret

Create a new secret in your account with attributes name, type and value. Attribute type can be password or ssh.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\SecretsApi(
    // 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
);
$x_request_id = 04e0f898-37b4-48bc-a794-1a57abe6aa31; // string | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
$create_secret_request = new \OpenAPI\Client\Model\CreateSecretRequest(); // \OpenAPI\Client\Model\CreateSecretRequest
$x_trace_id = 'x_trace_id_example'; // string | Identifier to trace group of requests.

try {
    $result = $apiInstance->createSecret($x_request_id, $create_secret_request, $x_trace_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecretsApi->createSecret: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_request_id	string	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
create_secret_request	\OpenAPI\Client\Model\CreateSecretRequest
x_trace_id	string	Identifier to trace group of requests.	[optional]

Return type

\OpenAPI\Client\Model\CreateSecretResponse

Authorization

bearer

HTTP request headers

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

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

`deleteSecret()`

deleteSecret($x_request_id, $secret_id, $x_trace_id)

Delete existing secret by id

You can remove a specific secret from your account.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\SecretsApi(
    // 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
);
$x_request_id = 04e0f898-37b4-48bc-a794-1a57abe6aa31; // string | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
$secret_id = 123; // int | The id of the secret
$x_trace_id = 'x_trace_id_example'; // string | Identifier to trace group of requests.

try {
    $apiInstance->deleteSecret($x_request_id, $secret_id, $x_trace_id);
} catch (Exception $e) {
    echo 'Exception when calling SecretsApi->deleteSecret: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_request_id	string	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
secret_id	int	The id of the secret
x_trace_id	string	Identifier to trace group of requests.	[optional]

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`retrieveSecret()`

retrieveSecret($x_request_id, $secret_id, $x_trace_id): \OpenAPI\Client\Model\FindSecretResponse

Get specific secret by id

Get attributes values for a specific secret on your account.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\SecretsApi(
    // 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
);
$x_request_id = 04e0f898-37b4-48bc-a794-1a57abe6aa31; // string | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
$secret_id = 123; // int | The id of the secret
$x_trace_id = 'x_trace_id_example'; // string | Identifier to trace group of requests.

try {
    $result = $apiInstance->retrieveSecret($x_request_id, $secret_id, $x_trace_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecretsApi->retrieveSecret: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_request_id	string	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
secret_id	int	The id of the secret
x_trace_id	string	Identifier to trace group of requests.	[optional]

Return type

\OpenAPI\Client\Model\FindSecretResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`retrieveSecretList()`

retrieveSecretList($x_request_id, $x_trace_id, $page, $size, $order_by, $name, $type): \OpenAPI\Client\Model\ListSecretResponse

List secrets

List and filter all secrets in your account.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\SecretsApi(
    // 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
);
$x_request_id = 04e0f898-37b4-48bc-a794-1a57abe6aa31; // string | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
$x_trace_id = 'x_trace_id_example'; // string | Identifier to trace group of requests.
$page = 1; // int | Number of page to be fetched.
$size = 10; // int | Number of elements per page.
$order_by = name:asc; // string[] | Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`.
$name = mysecret; // string | Filter secrets by name
$type = 'type_example'; // string | Filter secrets by type

try {
    $result = $apiInstance->retrieveSecretList($x_request_id, $x_trace_id, $page, $size, $order_by, $name, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecretsApi->retrieveSecretList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_request_id	string	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
x_trace_id	string	Identifier to trace group of requests.	[optional]
page	int	Number of page to be fetched.	[optional]
size	int	Number of elements per page.	[optional]
order_by	string[]	Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC	DESC`.
name	string	Filter secrets by name	[optional]
type	string	Filter secrets by type	[optional]

Return type

\OpenAPI\Client\Model\ListSecretResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateSecret()`

updateSecret($x_request_id, $secret_id, $update_secret_request, $x_trace_id): \OpenAPI\Client\Model\UpdateSecretResponse

Update specific secret by id

Update attributes to your secret. Attributes are optional. If not set, the attributes will retain their original values. Only name and value can be updated.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\SecretsApi(
    // 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
);
$x_request_id = 04e0f898-37b4-48bc-a794-1a57abe6aa31; // string | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
$secret_id = 123; // int | The id of the secret
$update_secret_request = new \OpenAPI\Client\Model\UpdateSecretRequest(); // \OpenAPI\Client\Model\UpdateSecretRequest
$x_trace_id = 'x_trace_id_example'; // string | Identifier to trace group of requests.

try {
    $result = $apiInstance->updateSecret($x_request_id, $secret_id, $update_secret_request, $x_trace_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecretsApi->updateSecret: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_request_id	string	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
secret_id	int	The id of the secret
update_secret_request	\OpenAPI\Client\Model\UpdateSecretRequest
x_trace_id	string	Identifier to trace group of requests.	[optional]

Return type

\OpenAPI\Client\Model\UpdateSecretResponse

Authorization

bearer

HTTP request headers

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SecretsApi.md

SecretsApi.md

OpenAPI\Client\SecretsApi

`createSecret()`

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteSecret()`

Example

Parameters

Return type

Authorization

HTTP request headers

`retrieveSecret()`

Example

Parameters

Return type

Authorization

HTTP request headers

`retrieveSecretList()`

Example

Parameters

Return type

Authorization

HTTP request headers

`updateSecret()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

SecretsApi.md

Latest commit

History

SecretsApi.md

File metadata and controls

OpenAPI\Client\SecretsApi

createSecret()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSecret()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveSecret()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveSecretList()

Example

Parameters

Return type

Authorization

HTTP request headers

updateSecret()

Example

Parameters

Return type

Authorization

HTTP request headers

`createSecret()`

`deleteSecret()`

`retrieveSecret()`

`retrieveSecretList()`

`updateSecret()`