Skip to content

Latest commit

 

History

History
199 lines (125 loc) · 5.9 KB

AclApi.md

File metadata and controls

199 lines (125 loc) · 5.9 KB
Raw

AclApi

Note

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

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.

let cfg = &Configuration::default();
let params = CreateAclParams {
    // parameters
};
create_acl(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
name Option<String> Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

Return type

crate::models::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 README]

delete_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.

let cfg = &Configuration::default();
let params = DeleteAclParams {
    // parameters
};
delete_acl(cfg, params)

Parameters

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

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

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

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

get_acl

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

let cfg = &Configuration::default();
let params = GetAclParams {
    // parameters
};
get_acl(cfg, params)

Parameters

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

Return type

crate::models::AclResponse

Authorization

token

HTTP request headers

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

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

list_acls

List ACLs.

let cfg = &Configuration::default();
let params = ListAclsParams {
    // parameters
};
list_acls(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]

Return type

Vec<crate::models::AclResponse>

Authorization

token

HTTP request headers

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

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

update_acl

Update an ACL for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateAclParams {
    // parameters
};
update_acl(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
acl_name String Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. [required]
name Option<String> Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace.

Return type

crate::models::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 README]