Fastly

An asynchronous JavaScript client library for interacting with most facets of the Fastly API.

NOTE: This API client is auto-generated from Fastly's OpenAPI specification and may not function correctly when used on the Compute@Edge platform. Support for Compute@Edge is on the roadmap but has not yet been prioritised.

Usage

import Fastly from "fastly";

const apiInstance = new Fastly.AclApi();

// If the FASTLY_API_TOKEN environment variable is set,
// the client will use it to authenticate all API requests.
// Alternatively, you may authorize the client instance
// with a Fastly API token, which will override
// the environment variable.
// Fastly.ApiClient.instance.authenticate("YOUR_API_TOKEN");

const options = {
  service_id: "SU1Z0isxPaozGVKXdv0eY", // required
  version_id: 56, // required
  name: "my_acl",
};

apiInstance.createAcl(options)
  .then((data) => {
    console.log(data, 'API called successfully.');
  })
  .catch((error) => {
    console.error(error);
  });

Authorization

The Fastly API requires an API token for most operations. If the FASTLY_API_TOKEN environment variable is set, the client will automatically use it to authenticate all API requests. Alternatively, you may authenticate the client instance with a Fastly API token, which will override the environment variable.

Fastly.ApiClient.instance.authenticate("YOUR_API_TOKEN");

Documentation for API Endpoints

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

Issues

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

• /resources/stores/kv/{store_id}/batch (PUT)
• /tls/activations/{tls_activation_id} (GET, PATCH)
• /tls/activations (GET)
• /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.