You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-5
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Fastly PHP
2
2
3
-
A PHP client library for interacting with most facets of the [Fastly API](https://developer.fastly.com/reference/api).
3
+
A PHP client library for interacting with most facets of the [Fastly API](https://www.fastly.com/documentation/reference/api/).
4
4
5
5
6
6
## Installation
@@ -59,7 +59,10 @@ try {
59
59
60
60
## Authorization
61
61
62
-
The Fastly API requires an [API token](https://developer.fastly.com/reference/api/#authentication) for most operations. Set it in the PHP client by using the `setApiToken` method of a configuration as shown:
62
+
> [!NOTE]
63
+
> The Fastly API requires an [API token](https://www.fastly.com/documentation/reference/api/#authentication) for most operations.
64
+
65
+
Set up the API token in the PHP client by using the `setApiToken` method of a configuration as shown:
@@ -71,12 +74,16 @@ Alternatively, set the `FASTLY_API_TOKEN` environment variable instead of using
71
74
Fastly\Configuration::getDefaultConfiguration();
72
75
```
73
76
74
-
## Documentation for API Endpoints
77
+
## API Endpoints
78
+
79
+
The main documentation for the Fastly API can be found on our [Developer Hub](https://www.fastly.com/documentation/reference/api/).
75
80
76
-
The main documentation for the Fastly API can be found on our [Developer Hub](https://developer.fastly.com/reference/api).
81
+
<details>
82
+
83
+
<summary>Table of API endpoints</summary>
77
84
78
85
Class | Method | Description
79
-
------------ | ------------- | -------------
86
+
----- | ------ | -----------
80
87
[*AclApi*](docs/Api/AclApi.md) | [**createAcl**](docs/Api/AclApi.md#createacl) | Create a new ACL
81
88
[*AclApi*](docs/Api/AclApi.md) | [**deleteAcl**](docs/Api/AclApi.md#deleteacl) | Delete an ACL
82
89
[*AclApi*](docs/Api/AclApi.md) | [**getAcl**](docs/Api/AclApi.md#getacl) | Describe an ACL
@@ -242,6 +249,8 @@ Class | Method | Description
242
249
[*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**removeUserGroupRoles**](docs/Api/IamUserGroupsApi.md#removeusergrouproles) | Remove roles from a user group
243
250
[*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**removeUserGroupServiceGroups**](docs/Api/IamUserGroupsApi.md#removeusergroupservicegroups) | Remove service groups from a user group
244
251
[*IamUserGroupsApi*](docs/Api/IamUserGroupsApi.md) | [**updateAUserGroup**](docs/Api/IamUserGroupsApi.md#updateausergroup) | Update a user group
252
+
[*ImageOptimizerDefaultSettingsApi*](docs/Api/ImageOptimizerDefaultSettingsApi.md) | [**getDefaultSettings**](docs/Api/ImageOptimizerDefaultSettingsApi.md#getdefaultsettings) | Get current Image Optimizer Default Settings
[*InvitationsApi*](docs/Api/InvitationsApi.md) | [**createInvitation**](docs/Api/InvitationsApi.md#createinvitation) | Create an invitation
246
255
[*InvitationsApi*](docs/Api/InvitationsApi.md) | [**deleteInvitation**](docs/Api/InvitationsApi.md#deleteinvitation) | Delete an invitation
247
256
[*InvitationsApi*](docs/Api/InvitationsApi.md) | [**listInvitations**](docs/Api/InvitationsApi.md#listinvitations) | List invitations
@@ -610,6 +619,8 @@ Class | Method | Description
610
619
[*WholePlatformDdosHistoricalApi*](docs/Api/WholePlatformDdosHistoricalApi.md) | [**getPlatformDdosHistorical**](docs/Api/WholePlatformDdosHistoricalApi.md#getplatformddoshistorical) | Get historical DDoS metrics for the entire Fastly platform
611
620
612
621
622
+
</details>
623
+
613
624
## Issues
614
625
615
626
The fastly-php API client currently does not support the following endpoints:
Copy file name to clipboardExpand all lines: docs/Api/CacheSettingsApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\CacheSettingsApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**createCacheSettings()**](CacheSettingsApi.md#createCacheSettings) | **POST** /service/{service_id}/version/{version_id}/cache_settings | Create a cache settings object
18
21
[**deleteCacheSettings()**](CacheSettingsApi.md#deleteCacheSettings) | **DELETE** /service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name} | Delete a cache settings object
19
22
[**getCacheSettings()**](CacheSettingsApi.md#getCacheSettings) | **GET** /service/{service_id}/version/{version_id}/cache_settings/{cache_settings_name} | Get a cache settings object
Copy file name to clipboardExpand all lines: docs/Api/ConfigStoreItemApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\ConfigStoreItemApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**bulkUpdateConfigStoreItem()**](ConfigStoreItemApi.md#bulkUpdateConfigStoreItem) | **PATCH** /resources/stores/config/{config_store_id}/items | Update multiple entries in a config store
18
21
[**createConfigStoreItem()**](ConfigStoreItemApi.md#createConfigStoreItem) | **POST** /resources/stores/config/{config_store_id}/item | Create an entry in a config store
19
22
[**deleteConfigStoreItem()**](ConfigStoreItemApi.md#deleteConfigStoreItem) | **DELETE** /resources/stores/config/{config_store_id}/item/{config_store_item_key} | Delete an item from a config store
Copy file name to clipboardExpand all lines: docs/Api/DictionaryApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DictionaryApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**createDictionary()**](DictionaryApi.md#createDictionary) | **POST** /service/{service_id}/version/{version_id}/dictionary | Create an edge dictionary
18
21
[**deleteDictionary()**](DictionaryApi.md#deleteDictionary) | **DELETE** /service/{service_id}/version/{version_id}/dictionary/{dictionary_name} | Delete an edge dictionary
19
22
[**getDictionary()**](DictionaryApi.md#getDictionary) | **GET** /service/{service_id}/version/{version_id}/dictionary/{dictionary_name} | Get an edge dictionary
Copy file name to clipboardExpand all lines: docs/Api/DictionaryItemApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DictionaryItemApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**bulkUpdateDictionaryItem()**](DictionaryItemApi.md#bulkUpdateDictionaryItem) | **PATCH** /service/{service_id}/dictionary/{dictionary_id}/items | Update multiple entries in an edge dictionary
18
21
[**createDictionaryItem()**](DictionaryItemApi.md#createDictionaryItem) | **POST** /service/{service_id}/dictionary/{dictionary_id}/item | Create an entry in an edge dictionary
19
22
[**deleteDictionaryItem()**](DictionaryItemApi.md#deleteDictionaryItem) | **DELETE** /service/{service_id}/dictionary/{dictionary_id}/item/{dictionary_item_key} | Delete an item from an edge dictionary
Copy file name to clipboardExpand all lines: docs/Api/DiffApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DiffApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**diffServiceVersions()**](DiffApi.md#diffServiceVersions) | **GET** /service/{service_id}/diff/from/{from_version_id}/to/{to_version_id} | Diff two service versions
Copy file name to clipboardExpand all lines: docs/Api/DirectorApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DirectorApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**createDirector()**](DirectorApi.md#createDirector) | **POST** /service/{service_id}/version/{version_id}/director | Create a director
18
21
[**deleteDirector()**](DirectorApi.md#deleteDirector) | **DELETE** /service/{service_id}/version/{version_id}/director/{director_name} | Delete a director
19
22
[**getDirector()**](DirectorApi.md#getDirector) | **GET** /service/{service_id}/version/{version_id}/director/{director_name} | Get a director
Copy file name to clipboardExpand all lines: docs/Api/DirectorBackendApi.md
+5-2
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,11 @@ $apiInstance = new Fastly\Api\DirectorBackendApi(
12
12
13
13
## Methods
14
14
15
-
Method | Fastly API endpoint | Description
16
-
------------- | ------------- | -------------
15
+
> [!NOTE]
16
+
> All URIs are relative to `https://api.fastly.com`
17
+
18
+
Method | HTTP request | Description
19
+
------ | ------------ | -----------
17
20
[**createDirectorBackend()**](DirectorBackendApi.md#createDirectorBackend) | **POST** /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} | Create a director-backend relationship
18
21
[**deleteDirectorBackend()**](DirectorBackendApi.md#deleteDirectorBackend) | **DELETE** /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} | Delete a director-backend relationship
19
22
[**getDirectorBackend()**](DirectorBackendApi.md#getDirectorBackend) | **GET** /service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name} | Get a director-backend relationship
0 commit comments