All URIs are relative to https://cloud9.circuitid.com, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
createFirewall() | POST /firewall | Create a new object |
findFirewall() | GET /firewall | Find multiple objects |
getFirewall() | GET /firewall/{id} | Get object by id |
patchFirewall() | PATCH /firewall/{id} | Patch object's data |
removeFirewall() | DELETE /firewall/{id} | Delete object by id |
createFirewall($firewallCreateOrPatch): \OpenAPI\Client\CircuitID\GetFirewall200Response
Create a new object
Add a new object to the system.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\FirewallApi(
// 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
);
$firewallCreateOrPatch = new \OpenAPI\Client\CircuitID\FirewallCreateOrPatch(); // \OpenAPI\Client\CircuitID\FirewallCreateOrPatch | The JSON object that will be posted to the REST API endpoint.
try {
$result = $apiInstance->createFirewall($firewallCreateOrPatch);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FirewallApi->createFirewall: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
firewallCreateOrPatch | \OpenAPI\Client\CircuitID\FirewallCreateOrPatch | The JSON object that will be posted to the REST API endpoint. |
\OpenAPI\Client\CircuitID\GetFirewall200Response
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
findFirewall($search, $limit, $skip, $sort, $select, $or, $and): \OpenAPI\Client\CircuitID\FindFirewall200Response
Find multiple objects
Search and retrieve multiple objects simultaneously.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\FirewallApi(
// 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
);
$search = 'search_example'; // string | Filter results by the specified value.
$limit = 56; // int | $limit will return only the number of results you specify.
$skip = 56; // int | $skip will skip the specified number of results.
$sort = array('key' => new \stdClass); // object | $sort will sort based on the object you provide. It can contain a list of properties by which to sort mapped to the order (1 ascending, -1 descending).
$select = array('select_example'); // string[] | $select allows to pick which fields to include in the result.
$or = array(new \stdClass); // object[] | Find all records that match any of the given criteria.
$and = array(new \stdClass); // object[] | Find all records that match all of the given criteria.
try {
$result = $apiInstance->findFirewall($search, $limit, $skip, $sort, $select, $or, $and);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FirewallApi->findFirewall: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
search | string | Filter results by the specified value. | [optional] |
limit | int | $limit will return only the number of results you specify. | [optional] |
skip | int | $skip will skip the specified number of results. | [optional] |
sort | object | $sort will sort based on the object you provide. It can contain a list of properties by which to sort mapped to the order (1 ascending, -1 descending). | [optional] |
select | string[] | $select allows to pick which fields to include in the result. | [optional] |
or | object[] | Find all records that match any of the given criteria. | [optional] |
and | object[] | Find all records that match all of the given criteria. | [optional] |
\OpenAPI\Client\CircuitID\FindFirewall200Response
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getFirewall($id): \OpenAPI\Client\CircuitID\GetFirewall200Response
Get object by id
Get an object from the REST API Endpoint by its unique id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\FirewallApi(
// 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
);
$id = 'id_example'; // string | The ObjectId (unique 12 bytes ID) of record you would like to GET.
try {
$result = $apiInstance->getFirewall($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FirewallApi->getFirewall: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | The ObjectId (unique 12 bytes ID) of record you would like to GET. |
\OpenAPI\Client\CircuitID\GetFirewall200Response
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
patchFirewall($id, $firewallCreateOrPatch): \OpenAPI\Client\CircuitID\GetFirewall200Response
Patch object's data
Make updates to specific fields within the record without replacing the entire dataset.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\FirewallApi(
// 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
);
$id = 'id_example'; // string | The ObjectId (unique 12 bytes ID) of record you would like to GET.
$firewallCreateOrPatch = new \OpenAPI\Client\CircuitID\FirewallCreateOrPatch(); // \OpenAPI\Client\CircuitID\FirewallCreateOrPatch | The request data.
try {
$result = $apiInstance->patchFirewall($id, $firewallCreateOrPatch);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FirewallApi->patchFirewall: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | The ObjectId (unique 12 bytes ID) of record you would like to GET. | |
firewallCreateOrPatch | \OpenAPI\Client\CircuitID\FirewallCreateOrPatch | The request data. |
\OpenAPI\Client\CircuitID\GetFirewall200Response
- Content-Type:
application/json
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
removeFirewall($id): \OpenAPI\Client\CircuitID\GetFirewall200Response
Delete object by id
Delete an object by id, removing it from the service.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: jwt
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$apiInstance = new OpenAPI\Client\Api\FirewallApi(
// 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
);
$id = 'id_example'; // string | The ObjectId (unique 12 bytes ID) of record you would like to GET.
try {
$result = $apiInstance->removeFirewall($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FirewallApi->removeFirewall: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | The ObjectId (unique 12 bytes ID) of record you would like to GET. |
\OpenAPI\Client\CircuitID\GetFirewall200Response
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]