|
| 1 | +# Fastly\Api\DmDomainsApi |
| 2 | + |
| 3 | + |
| 4 | +```php |
| 5 | +$apiInstance = new Fastly\Api\DmDomainsApi( |
| 6 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 7 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 8 | + new GuzzleHttp\Client(), |
| 9 | + $config |
| 10 | +); |
| 11 | +``` |
| 12 | + |
| 13 | +## Methods |
| 14 | + |
| 15 | +> [!NOTE] |
| 16 | +> All URIs are relative to `https://api.fastly.com` |
| 17 | +
|
| 18 | +Method | HTTP request | Description |
| 19 | +------ | ------------ | ----------- |
| 20 | +[**createDmDomain()**](DmDomainsApi.md#createDmDomain) | **POST** /domain-management/v1/domains | Create a domain |
| 21 | +[**deleteDmDomain()**](DmDomainsApi.md#deleteDmDomain) | **DELETE** /domain-management/v1/domains/{domain_id} | Delete a domain |
| 22 | +[**getDmDomain()**](DmDomainsApi.md#getDmDomain) | **GET** /domain-management/v1/domains/{domain_id} | Get a domain |
| 23 | +[**listDmDomains()**](DmDomainsApi.md#listDmDomains) | **GET** /domain-management/v1/domains | List domains |
| 24 | +[**updateDmDomain()**](DmDomainsApi.md#updateDmDomain) | **PATCH** /domain-management/v1/domains/{domain_id} | Update a domain |
| 25 | + |
| 26 | + |
| 27 | +## `createDmDomain()` |
| 28 | + |
| 29 | +```php |
| 30 | +createDmDomain($options): \Fastly\Model\SuccessfulResponseAsObject // Create a domain |
| 31 | +``` |
| 32 | + |
| 33 | +Create a domain |
| 34 | + |
| 35 | +### Example |
| 36 | +```php |
| 37 | + $options['request_body_for_create'] = new \Fastly\Model\RequestBodyForCreate(); // \Fastly\Model\RequestBodyForCreate |
| 38 | + |
| 39 | +try { |
| 40 | + $result = $apiInstance->createDmDomain($options); |
| 41 | +} catch (Exception $e) { |
| 42 | + echo 'Exception when calling DmDomainsApi->createDmDomain: ', $e->getMessage(), PHP_EOL; |
| 43 | +} |
| 44 | +``` |
| 45 | + |
| 46 | +### Options |
| 47 | + |
| 48 | +Note: the input parameter is an associative array with the keys listed below. |
| 49 | + |
| 50 | +Name | Type | Description | Notes |
| 51 | +------------- | ------------- | ------------- | ------------- |
| 52 | +**request_body_for_create** | [**\Fastly\Model\RequestBodyForCreate**](../Model/RequestBodyForCreate.md) | | [optional] |
| 53 | + |
| 54 | +### Return type |
| 55 | + |
| 56 | +[**\Fastly\Model\SuccessfulResponseAsObject**](../Model/SuccessfulResponseAsObject.md) |
| 57 | + |
| 58 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 59 | +[[Back to README]](../../README.md) |
| 60 | + |
| 61 | +## `deleteDmDomain()` |
| 62 | + |
| 63 | +```php |
| 64 | +deleteDmDomain($options) // Delete a domain |
| 65 | +``` |
| 66 | + |
| 67 | +Delete a domain |
| 68 | + |
| 69 | +### Example |
| 70 | +```php |
| 71 | + $options['domain_id'] = 'domain_id_example'; // string |
| 72 | + |
| 73 | +try { |
| 74 | + $apiInstance->deleteDmDomain($options); |
| 75 | +} catch (Exception $e) { |
| 76 | + echo 'Exception when calling DmDomainsApi->deleteDmDomain: ', $e->getMessage(), PHP_EOL; |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +### Options |
| 81 | + |
| 82 | +Note: the input parameter is an associative array with the keys listed below. |
| 83 | + |
| 84 | +Name | Type | Description | Notes |
| 85 | +------------- | ------------- | ------------- | ------------- |
| 86 | +**domain_id** | **string** | | |
| 87 | + |
| 88 | +### Return type |
| 89 | + |
| 90 | +void (empty response body) |
| 91 | + |
| 92 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 93 | +[[Back to README]](../../README.md) |
| 94 | + |
| 95 | +## `getDmDomain()` |
| 96 | + |
| 97 | +```php |
| 98 | +getDmDomain($options): \Fastly\Model\SuccessfulResponseAsObject // Get a domain |
| 99 | +``` |
| 100 | + |
| 101 | +Show a domain |
| 102 | + |
| 103 | +### Example |
| 104 | +```php |
| 105 | + $options['domain_id'] = 'domain_id_example'; // string |
| 106 | + |
| 107 | +try { |
| 108 | + $result = $apiInstance->getDmDomain($options); |
| 109 | +} catch (Exception $e) { |
| 110 | + echo 'Exception when calling DmDomainsApi->getDmDomain: ', $e->getMessage(), PHP_EOL; |
| 111 | +} |
| 112 | +``` |
| 113 | + |
| 114 | +### Options |
| 115 | + |
| 116 | +Note: the input parameter is an associative array with the keys listed below. |
| 117 | + |
| 118 | +Name | Type | Description | Notes |
| 119 | +------------- | ------------- | ------------- | ------------- |
| 120 | +**domain_id** | **string** | | |
| 121 | + |
| 122 | +### Return type |
| 123 | + |
| 124 | +[**\Fastly\Model\SuccessfulResponseAsObject**](../Model/SuccessfulResponseAsObject.md) |
| 125 | + |
| 126 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 127 | +[[Back to README]](../../README.md) |
| 128 | + |
| 129 | +## `listDmDomains()` |
| 130 | + |
| 131 | +```php |
| 132 | +listDmDomains($options): \Fastly\Model\InlineResponse2004 // List domains |
| 133 | +``` |
| 134 | + |
| 135 | +List all domains |
| 136 | + |
| 137 | +### Example |
| 138 | +```php |
| 139 | + $options['fqdn'] = 'fqdn_example'; // string |
| 140 | +$options['service_id'] = 'service_id_example'; // string | Filter results based on a service_id. |
| 141 | +$options['sort'] = 'fqdn'; // string | The order in which to list the results. |
| 142 | +$options['activated'] = True; // bool |
| 143 | +$options['verified'] = True; // bool |
| 144 | +$options['cursor'] = 'cursor_example'; // string | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. |
| 145 | +$options['limit'] = 20; // int | Limit how many results are returned. |
| 146 | + |
| 147 | +try { |
| 148 | + $result = $apiInstance->listDmDomains($options); |
| 149 | +} catch (Exception $e) { |
| 150 | + echo 'Exception when calling DmDomainsApi->listDmDomains: ', $e->getMessage(), PHP_EOL; |
| 151 | +} |
| 152 | +``` |
| 153 | + |
| 154 | +### Options |
| 155 | + |
| 156 | +Note: the input parameter is an associative array with the keys listed below. |
| 157 | + |
| 158 | +Name | Type | Description | Notes |
| 159 | +------------- | ------------- | ------------- | ------------- |
| 160 | +**fqdn** | **string** | | [optional] |
| 161 | +**service_id** | **string** | Filter results based on a service_id. | [optional] |
| 162 | +**sort** | **string** | The order in which to list the results. | [optional] [one of: 'fqdn', '-fqdn'] [defaults to 'fqdn'] |
| 163 | +**activated** | **bool** | | [optional] |
| 164 | +**verified** | **bool** | | [optional] |
| 165 | +**cursor** | **string** | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | [optional] |
| 166 | +**limit** | **int** | Limit how many results are returned. | [optional] [defaults to 20] |
| 167 | + |
| 168 | +### Return type |
| 169 | + |
| 170 | +[**\Fastly\Model\InlineResponse2004**](../Model/InlineResponse2004.md) |
| 171 | + |
| 172 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 173 | +[[Back to README]](../../README.md) |
| 174 | + |
| 175 | +## `updateDmDomain()` |
| 176 | + |
| 177 | +```php |
| 178 | +updateDmDomain($options): \Fastly\Model\SuccessfulResponseAsObject // Update a domain |
| 179 | +``` |
| 180 | + |
| 181 | +Update a domain |
| 182 | + |
| 183 | +### Example |
| 184 | +```php |
| 185 | + $options['domain_id'] = 'domain_id_example'; // string |
| 186 | +$options['request_body_for_update'] = new \Fastly\Model\RequestBodyForUpdate(); // \Fastly\Model\RequestBodyForUpdate |
| 187 | + |
| 188 | +try { |
| 189 | + $result = $apiInstance->updateDmDomain($options); |
| 190 | +} catch (Exception $e) { |
| 191 | + echo 'Exception when calling DmDomainsApi->updateDmDomain: ', $e->getMessage(), PHP_EOL; |
| 192 | +} |
| 193 | +``` |
| 194 | + |
| 195 | +### Options |
| 196 | + |
| 197 | +Note: the input parameter is an associative array with the keys listed below. |
| 198 | + |
| 199 | +Name | Type | Description | Notes |
| 200 | +------------- | ------------- | ------------- | ------------- |
| 201 | +**domain_id** | **string** | | |
| 202 | +**request_body_for_update** | [**\Fastly\Model\RequestBodyForUpdate**](../Model/RequestBodyForUpdate.md) | | [optional] |
| 203 | + |
| 204 | +### Return type |
| 205 | + |
| 206 | +[**\Fastly\Model\SuccessfulResponseAsObject**](../Model/SuccessfulResponseAsObject.md) |
| 207 | + |
| 208 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 209 | +[[Back to README]](../../README.md) |
0 commit comments