fastly-api

Crates.io	fastly-api
lib.rs	fastly-api
version	4.13.0
source	src
created_at	2022-09-05 13:42:13.213369
updated_at	2024-10-23 07:07:44.460759
description	Fastly API client
homepage
repository	https://github.com/fastly/fastly-rust/
max_upload_size
id	658856
size	5,930,376

Katsuyuki Omuro (harmony7)

documentation

README

fastly-api

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

[!WARNING] This API client is auto-generated from Fastly's OpenAPI specification and may not function correctly when used on the Compute platform. Support for Compute is on the roadmap but has not yet been prioritized.

Requirements

Rust 2021 Edition

Installation

Add the following to Cargo.toml under [dependencies]:

fastly-api = "4.13.0"

Usage

use anyhow::Result;
use fastly_api::apis::configuration::{ApiKey, Configuration};
use fastly_api::apis::service_api::{create_service, CreateServiceParams};
use std::env;

#[tokio::main]
async fn main() -> Result<()> {
    let cfg = &Configuration {
        api_key: Some(ApiKey {
            prefix: None,
            key: "YOUR_API_KEY",
        }),
        ..Default::default()
    };
    let service_name = "fastly-rust-service";

    let customer_id = env::var("FASTLY_CUSTOMER_ID")?;
    let params = CreateServiceParams {
        name: Some(service_name.to_string()),
        customer_id: Some(customer_id),
        ..Default::default()
    };

    create_service(cfg, params).await?
}

Authorization

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

Set up the API token by assigning api_key to a configuration as shown:

let cfg = &Configuration {
    api_key: Some(ApiKey {
        prefix: None,
        key: "YOUR_API_KEY",
    }),
    ..Default::default()
};

Alternatively, set the FASTLY_API_TOKEN environment variable and use the default constructor:

let cfg = &Configuration::default();

API Endpoints

The main documentation for the Fastly API can be found on our Developer Hub.

Table of API endpoints

Class	Method	Description

Issues

The fastly-rust 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)
/service/{service_id}/version/{version_id}/director (POST)
/stats/aggregate (GET)
/stats/field/{field} (GET)
/stats/regions (GET)
/stats/service/{service_id}/field/{field} (GET)
/stats/service/{service_id} (GET)
/stats/usage_by_month (GET)
/stats/usage_by_service (GET)
/stats/usage (GET)
/stats (GET)
/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.

Commit count: 49

fastly-api

documentation

README

fastly-api

Requirements

Installation

Usage

Authorization

API Endpoints

Issues

Security issues

License

cargo fmt