Skip to content

AclEntryApi.md

Latest commit

 

History

History
277 lines (210 loc) · 8.65 KB

AclEntryApi.md

File metadata and controls

277 lines (210 loc) · 8.65 KB

Fastly::AclEntryApi

require 'fastly'
api_instance = Fastly::AclEntryApi.new

Methods

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
bulk_update_acl_entries PATCH /service/{service_id}/acl/{acl_id}/entries Update multiple ACL entries
create_acl_entry POST /service/{service_id}/acl/{acl_id}/entry Create an ACL entry
delete_acl_entry DELETE /service/{service_id}/acl/{acl_id}/entry/{acl_entry_id} Delete an ACL entry
get_acl_entry GET /service/{service_id}/acl/{acl_id}/entry/{acl_entry_id} Describe an ACL entry
list_acl_entries GET /service/{service_id}/acl/{acl_id}/entries List ACL entries
update_acl_entry PATCH /service/{service_id}/acl/{acl_id}/entry/{acl_entry_id} Update an ACL entry

bulk_update_acl_entries()

bulk_update_acl_entries(opts): <InlineResponse200> # Update multiple ACL entries

Update multiple ACL entries on the same ACL. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 entries. Contact support to discuss raising this limit.

Examples

api_instance = Fastly::AclEntryApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    acl_id: 'acl_id_example', # String | Alphanumeric string identifying a ACL.
    bulk_update_acl_entries_request: Fastly::BulkUpdateAclEntriesRequest.new, # BulkUpdateAclEntriesRequest | 
}

begin
  # Update multiple ACL entries
  result = api_instance.bulk_update_acl_entries(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling AclEntryApi->bulk_update_acl_entries: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
acl_id String Alphanumeric string identifying a ACL.
bulk_update_acl_entries_request BulkUpdateAclEntriesRequest [optional]

Return type

InlineResponse200

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

create_acl_entry()

create_acl_entry(opts): <AclEntryResponse> # Create an ACL entry

Add an ACL entry to an ACL.

Examples

api_instance = Fastly::AclEntryApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    acl_id: 'acl_id_example', # String | Alphanumeric string identifying a ACL.
    acl_entry: Fastly::AclEntry.new, # AclEntry | 
}

begin
  # Create an ACL entry
  result = api_instance.create_acl_entry(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling AclEntryApi->create_acl_entry: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
acl_id String Alphanumeric string identifying a ACL.
acl_entry AclEntry [optional]

Return type

AclEntryResponse

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

delete_acl_entry()

delete_acl_entry(opts): <InlineResponse200> # Delete an ACL entry

Delete an ACL entry from a specified ACL.

Examples

api_instance = Fastly::AclEntryApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    acl_id: 'acl_id_example', # String | Alphanumeric string identifying a ACL.
    acl_entry_id: 'acl_entry_id_example', # String | Alphanumeric string identifying an ACL Entry.
}

begin
  # Delete an ACL entry
  result = api_instance.delete_acl_entry(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling AclEntryApi->delete_acl_entry: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
acl_id String Alphanumeric string identifying a ACL.
acl_entry_id String Alphanumeric string identifying an ACL Entry.

Return type

InlineResponse200

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

get_acl_entry()

get_acl_entry(opts): <AclEntryResponse> # Describe an ACL entry

Retrieve a single ACL entry.

Examples

api_instance = Fastly::AclEntryApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    acl_id: 'acl_id_example', # String | Alphanumeric string identifying a ACL.
    acl_entry_id: 'acl_entry_id_example', # String | Alphanumeric string identifying an ACL Entry.
}

begin
  # Describe an ACL entry
  result = api_instance.get_acl_entry(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling AclEntryApi->get_acl_entry: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
acl_id String Alphanumeric string identifying a ACL.
acl_entry_id String Alphanumeric string identifying an ACL Entry.

Return type

AclEntryResponse

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

list_acl_entries()

list_acl_entries(opts): <Array<AclEntryResponse>> # List ACL entries

List ACL entries for a specified ACL.

Examples

api_instance = Fastly::AclEntryApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    acl_id: 'acl_id_example', # String | Alphanumeric string identifying a ACL.
    page: 1, # Integer | Current page.
    per_page: 20, # Integer | Number of records per page.
    sort: 'created', # String | Field on which to sort.
    direction: 'ascend', # String | Direction in which to sort results.
}

begin
  # List ACL entries
  result = api_instance.list_acl_entries(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling AclEntryApi->list_acl_entries: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
acl_id String Alphanumeric string identifying a ACL.
page Integer Current page. [optional]
per_page Integer Number of records per page. [optional][default to 20]
sort String Field on which to sort. [optional][default to 'created']
direction String Direction in which to sort results. [optional][default to 'ascend']

Return type

Array<AclEntryResponse>

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

update_acl_entry()

update_acl_entry(opts): <AclEntryResponse> # Update an ACL entry

Update an ACL entry for a specified ACL.

Examples

api_instance = Fastly::AclEntryApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    acl_id: 'acl_id_example', # String | Alphanumeric string identifying a ACL.
    acl_entry_id: 'acl_entry_id_example', # String | Alphanumeric string identifying an ACL Entry.
    acl_entry: Fastly::AclEntry.new, # AclEntry | 
}

begin
  # Update an ACL entry
  result = api_instance.update_acl_entry(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling AclEntryApi->update_acl_entry: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
acl_id String Alphanumeric string identifying a ACL.
acl_entry_id String Alphanumeric string identifying an ACL Entry.
acl_entry AclEntry [optional]

Return type

AclEntryResponse

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