-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
github-actions
committed
Sep 13, 2024
1 parent
4fb0348
commit 12f2669
Showing
879 changed files
with
4,251 additions
and
961 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,270 @@ | ||
# Fastly.AclsInComputeApi | ||
|
||
```javascript | ||
const apiInstance = new Fastly.AclsInComputeApi(); | ||
``` | ||
## Methods | ||
|
||
> [!NOTE] | ||
> All URIs are relative to `https://api.fastly.com` | ||
Method | HTTP request | Description | ||
------ | ------------ | ----------- | ||
[**computeAclCreateAcls**](AclsInComputeApi.md#computeAclCreateAcls) | **POST** /resources/acls | Create a new ACL | ||
[**computeAclDeleteSAclId**](AclsInComputeApi.md#computeAclDeleteSAclId) | **DELETE** /resources/acls/{acl_id} | Delete an ACL | ||
[**computeAclListAclEntries**](AclsInComputeApi.md#computeAclListAclEntries) | **GET** /resources/acls/{acl_id}/entries | List an ACL | ||
[**computeAclListAcls**](AclsInComputeApi.md#computeAclListAcls) | **GET** /resources/acls | List ACLs | ||
[**computeAclListAclsSAclId**](AclsInComputeApi.md#computeAclListAclsSAclId) | **GET** /resources/acls/{acl_id} | Describe an ACL | ||
[**computeAclLookupAcls**](AclsInComputeApi.md#computeAclLookupAcls) | **GET** /resources/acls/{acl_id}/entry/{acl_ip} | Lookup an ACL | ||
[**computeAclUpdateAcls**](AclsInComputeApi.md#computeAclUpdateAcls) | **PATCH** /resources/acls/{acl_id}/entries | Update an ACL | ||
|
||
|
||
## `computeAclCreateAcls` | ||
|
||
```javascript | ||
computeAclCreateAcls({ , [compute_acl_create_acls_request] }) | ||
``` | ||
|
||
Create a new ACL. | ||
|
||
### Example | ||
|
||
```javascript | ||
const options = { | ||
compute_acl_create_acls_request: new Fastly.ComputeAclCreateAclsRequest(), | ||
}; | ||
|
||
apiInstance.computeAclCreateAcls(options) | ||
.then((data) => { | ||
console.log(data, "API called successfully."); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**compute_acl_create_acls_request** | [**ComputeAclCreateAclsRequest**](ComputeAclCreateAclsRequest.md) | | [optional] | ||
|
||
### Return type | ||
|
||
[**ComputeAclCreateAclsResponse**](ComputeAclCreateAclsResponse.md) | ||
|
||
|
||
## `computeAclDeleteSAclId` | ||
|
||
```javascript | ||
computeAclDeleteSAclId({ acl_id }) | ||
``` | ||
|
||
Delete an ACL. | ||
|
||
### Example | ||
|
||
```javascript | ||
const options = { | ||
acl_id: "acl_id_example", // required | ||
}; | ||
|
||
apiInstance.computeAclDeleteSAclId(options) | ||
.then(() => { | ||
console.log('API called successfully.'); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**acl_id** | **String** | | | ||
|
||
### Return type | ||
|
||
null (empty response body) | ||
|
||
|
||
## `computeAclListAclEntries` | ||
|
||
```javascript | ||
computeAclListAclEntries({ acl_id, [cursor, ][limit] }) | ||
``` | ||
|
||
List an ACL. | ||
|
||
### Example | ||
|
||
```javascript | ||
const options = { | ||
acl_id: "acl_id_example", // required | ||
cursor: "cursor_example", | ||
limit: 100, | ||
}; | ||
|
||
apiInstance.computeAclListAclEntries(options) | ||
.then((data) => { | ||
console.log(data, "API called successfully."); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**acl_id** | **String** | | | ||
**cursor** | **String** | | [optional] | ||
**limit** | **Number** | | [optional] [defaults to 100] | ||
|
||
### Return type | ||
|
||
[**ComputeAclListEntries**](ComputeAclListEntries.md) | ||
|
||
|
||
## `computeAclListAcls` | ||
|
||
```javascript | ||
computeAclListAcls() | ||
``` | ||
|
||
List all ACLs. | ||
|
||
### Example | ||
|
||
```javascript | ||
apiInstance.computeAclListAcls() | ||
.then((data) => { | ||
console.log(data, "API called successfully."); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
This endpoint does not need any parameters. | ||
|
||
### Return type | ||
|
||
[**[ComputeAclCreateAclsResponse]**](ComputeAclCreateAclsResponse.md) | ||
|
||
|
||
## `computeAclListAclsSAclId` | ||
|
||
```javascript | ||
computeAclListAclsSAclId({ acl_id }) | ||
``` | ||
|
||
Describe an ACL. | ||
|
||
### Example | ||
|
||
```javascript | ||
const options = { | ||
acl_id: "acl_id_example", // required | ||
}; | ||
|
||
apiInstance.computeAclListAclsSAclId(options) | ||
.then((data) => { | ||
console.log(data, "API called successfully."); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**acl_id** | **String** | | | ||
|
||
### Return type | ||
|
||
[**ComputeAclCreateAclsResponse**](ComputeAclCreateAclsResponse.md) | ||
|
||
|
||
## `computeAclLookupAcls` | ||
|
||
```javascript | ||
computeAclLookupAcls({ acl_id, acl_ip }) | ||
``` | ||
|
||
Find a matching ACL entry for an IP address. | ||
|
||
### Example | ||
|
||
```javascript | ||
const options = { | ||
acl_id: "acl_id_example", // required | ||
acl_ip: "acl_ip_example", // required | ||
}; | ||
|
||
apiInstance.computeAclLookupAcls(options) | ||
.then((data) => { | ||
console.log(data, "API called successfully."); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**acl_id** | **String** | | | ||
**acl_ip** | **String** | | | ||
|
||
### Return type | ||
|
||
[**ComputeAclLookup**](ComputeAclLookup.md) | ||
|
||
|
||
## `computeAclUpdateAcls` | ||
|
||
```javascript | ||
computeAclUpdateAcls({ acl_id, [compute_acl_update_entry] }) | ||
``` | ||
|
||
Update an ACL. | ||
|
||
### Example | ||
|
||
```javascript | ||
const options = { | ||
acl_id: "acl_id_example", // required | ||
compute_acl_update_entry: [new Fastly.ComputeAclUpdateEntry()], | ||
}; | ||
|
||
apiInstance.computeAclUpdateAcls(options) | ||
.then(() => { | ||
console.log('API called successfully.'); | ||
}) | ||
.catch((error) => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
### Options | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**acl_id** | **String** | | | ||
**compute_acl_update_entry** | [**[ComputeAclUpdateEntry]**](ComputeAclUpdateEntry.md) | | [optional] | ||
|
||
### Return type | ||
|
||
null (empty response body) | ||
|
||
|
||
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) | ||
[[Back to README]](../../README.md) |
3 changes: 2 additions & 1 deletion
3
docs/OriginInspectorRealtimeEntryRecorded.md → docs/ComputeAclCreateAclsRequest.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,10 @@ | ||
# Fastly.OriginInspectorRealtimeEntryRecorded | ||
# Fastly.ComputeAclCreateAclsRequest | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**name** | **String** | Human readable name of store | [optional] | ||
|
||
|
||
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) |
Oops, something went wrong.