fastly-py

A Python client library for interacting with most facets of the Fastly API.

Requirements

Python >=3.6

Installation

python3 -m pip install fastly

Usage

import fastly
from fastly.api import acl_api
from pprint import pprint

# Authorize the client with a Fastly API token.
configuration = fastly.Configuration()
configuration.api_token = 'YOUR_API_KEY'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = acl_api.AclApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str
    version_id = 1 # int
    name = "test-acl" # str

    try:
        # Create a new ACL
        api_response = api_instance.create_acl(service_id, version_id, name=name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling AclApi->create_acl: %s\n" % e)

Authorization

[!NOTE] The Fastly API requires an API token for most operations.

Set it by assigning api_token to a configuration as shown:

# Authorize the client with a Fastly API token.
configuration = fastly.Configuration()
configuration.api_token = 'YOUR_API_KEY'

Alternatively, set the FASTLY_API_TOKEN environment variable.

API Endpoints

Issues

The fastly-py API client currently does not support the following endpoints:

• /alerts/definitions/{definition_id} (DELETE, GET, PUT)
• /alerts/definitions (GET, POST)
• /alerts/history (GET)
• /dns/configurations/{dns_configuration_id} (DELETE, GET, PATCH)
• /dns/configurations (GET, POST)
• /domains/{domain_id} (DELETE, GET, PATCH)
• /domains (GET, POST)
• /notifications/integration-types (GET)
• /notifications/integrations/{integration_id}/rotateSigningKey (POST)
• /notifications/integrations/{integration_id}/signingKey (GET)
• /notifications/integrations/{integration_id} (DELETE, GET, PATCH)
• /notifications/integrations (GET, POST)
• /notifications/mailinglist-confirmations (POST)
• /resources/stores/kv/{store_id}/batch (PUT)
• /security/workspaces/{workspace_id}/events/{event_id} (GET, PATCH)
• /security/workspaces/{workspace_id}/events (GET)
• /security/workspaces/{workspace_id}/redactions/{redaction_id} (DELETE, GET, PATCH)
• /security/workspaces/{workspace_id}/redactions (GET, POST)
• /security/workspaces/{workspace_id}/requests/{request_id} (GET)
• /security/workspaces/{workspace_id}/requests (GET)
• /security/workspaces/{workspace_id}/rules/{rule_id} (DELETE, GET, PATCH)
• /security/workspaces/{workspace_id}/rules (GET, POST)
• /security/workspaces/{workspace_id}/timeseries (GET)
• /security/workspaces/{workspace_id}/virtual-patches/{virtual_patch_id} (GET, PATCH)
• /security/workspaces/{workspace_id}/virtual-patches (GET)
• /security/workspaces/{workspace_id} (DELETE, GET, PATCH)
• /security/workspaces (GET, POST)
• /tls/activations/{tls_activation_id} (GET, PATCH)
• /tls/activations (GET)
• /tls/configurations/{tls_configuration_id} (DELETE, GET, PATCH)
• /tls/configurations (GET, POST)
• /v1/channel/{service_id}/ts/h/limit/{max_entries} (GET)
• /v1/channel/{service_id}/ts/h (GET)
• /v1/channel/{service_id}/ts/{start_timestamp} (GET)

If you encounter any non-security-related bug or unexpected behavior, please file an issue using the bug report template.

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.

License

MIT.