Skip to content

Latest commit

 

History

History
293 lines (208 loc) · 10.4 KB

AclApi.md

File metadata and controls

293 lines (208 loc) · 10.4 KB

WebService::Fastly::AclApi

Load the API package

use WebService::Fastly::Object::AclApi;

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

Method HTTP request Description
create_acl POST /service/{service_id}/version/{version_id}/acl Create a new ACL
delete_acl DELETE /service/{service_id}/version/{version_id}/acl/{acl_name} Delete an ACL
get_acl GET /service/{service_id}/version/{version_id}/acl/{acl_name} Describe an ACL
list_acls GET /service/{service_id}/version/{version_id}/acl List ACLs
update_acl PUT /service/{service_id}/version/{version_id}/acl/{acl_name} Update an ACL

create_acl

AclResponse create_acl(service_id => $service_id, version_id => $version_id, name => $name)

Create a new ACL

Create a new ACL attached to the specified service version. A new, empty ACL must be attached to a draft version of a service. The version associated with the ACL must be activated to be used.

Example

use Data::Dumper;
use WebService::Fastly::AclApi;
my $api_instance = WebService::Fastly::AclApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $name = "name_example"; # string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

eval {
    my $result = $api_instance->create_acl(service_id => $service_id, version_id => $version_id, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AclApi->create_acl: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
name string Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. [optional]

Return type

AclResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

delete_acl

InlineResponse200 delete_acl(service_id => $service_id, version_id => $version_id, acl_name => $acl_name)

Delete an ACL

Delete an ACL from the specified service version. To remove an ACL from use, the ACL must be deleted from a draft version and the version without the ACL must be activated.

Example

use Data::Dumper;
use WebService::Fastly::AclApi;
my $api_instance = WebService::Fastly::AclApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $acl_name = "acl_name_example"; # string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

eval {
    my $result = $api_instance->delete_acl(service_id => $service_id, version_id => $version_id, acl_name => $acl_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AclApi->delete_acl: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
acl_name string Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

Return type

InlineResponse200

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_acl

AclResponse get_acl(service_id => $service_id, version_id => $version_id, acl_name => $acl_name)

Describe an ACL

Retrieve a single ACL by name for the version and service.

Example

use Data::Dumper;
use WebService::Fastly::AclApi;
my $api_instance = WebService::Fastly::AclApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $acl_name = "acl_name_example"; # string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

eval {
    my $result = $api_instance->get_acl(service_id => $service_id, version_id => $version_id, acl_name => $acl_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AclApi->get_acl: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
acl_name string Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

Return type

AclResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

list_acls

ARRAY[AclResponse] list_acls(service_id => $service_id, version_id => $version_id)

List ACLs

List ACLs.

Example

use Data::Dumper;
use WebService::Fastly::AclApi;
my $api_instance = WebService::Fastly::AclApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.

eval {
    my $result = $api_instance->list_acls(service_id => $service_id, version_id => $version_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AclApi->list_acls: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.

Return type

ARRAY[AclResponse]

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

update_acl

AclResponse update_acl(service_id => $service_id, version_id => $version_id, acl_name => $acl_name, name => $name)

Update an ACL

Update an ACL for a particular service and version.

Example

use Data::Dumper;
use WebService::Fastly::AclApi;
my $api_instance = WebService::Fastly::AclApi->new(

    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);

my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $acl_name = "acl_name_example"; # string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.
my $name = "name_example"; # string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

eval {
    my $result = $api_instance->update_acl(service_id => $service_id, version_id => $version_id, acl_name => $acl_name, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AclApi->update_acl: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
acl_name string Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.
name string Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. [optional]

Return type

AclResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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