## Script types
Posting supports three types of scripts, which run at different points in the request/response lifecycle:
1. **Setup Scripts**: Runs before the request is constructed. This is useful for setting initial variables which may be substituted into the request.
2. **Pre-request Scripts**: Runs after the request has been constructed and variables have been substituted, but before the request is sent. You can directly modify the request object here.
3. **Post-response Scripts**: Runs after the response is received. This is useful for extracting data from the response, or for performing cleanup.
## Writing scripts
In the context of Posting, a "script" is a regular Python function.
By default, if you specify a path to a Python file, Posting will look for and execute the following functions at the appropriate times:
- `setup(posting: Posting) -> None`
- `on_request(request: RequestModel, posting: Posting) -> None`
- `on_response(response: httpx.Response, posting: Posting) -> None`
However, you can have Posting call any function you wish using the syntax `path/to/script.py:function_to_run`.
Note that relative paths are relative to the collection directory.
This ensures that if you place scripts inside your collection directory,
they're included when you share a collection with others.
Note that you do not need to specify all of the arguments when writing these functions. Posting will only pass the number of arguments that you've specified when it calls your function. For example, you could define a your `on_request` function as `def on_request(request: RequestModel) -> None` and Posting would call it with `on_request(request: RequestModel)` without passing the `posting` argument.
## Editing scripts
When you edit a script, it'll automatically be reloaded.
This means you can keep Posting open while editing it.
Posting also allows you to quickly jump to your editor (assuming you've set the `$EDITOR` or `$POSTING_EDITOR` environment variables) to edit a script.
Press ++ctrl+e++ while a script input field inside the `Scripts` tab is focused to open the path in your editor.
!!! warning
As of version 2.0.0, the script file must exist *before* pressing ++ctrl+e++. Posting will not create the file for you.
## Script logs
If your script writes to `stdout` or `stderr`, you'll see the output in the `Scripts` tab in the Response section.
This output is not persisted on disk.
### Example: Setup script
The **setup script** is run before the request is built.
You can set variables in the setup script that can be used in the request.
For example, you could use `httpx` to fetch an access token, then set the token as a variable so that it may be substituted into the request.
```python
def setup(posting: Posting) -> None:
# Set a variable which may be used in this request
# (or other requests to follow)
posting.set_variable("auth_token", "1234567890")
```
With this setup script attached to a request, you can then reference the `auth_token` variable in the request UI by typing `$auth_token`.
The `$auth_token` variable will remain for the duration of the session,
so you may wish to add a check to see if it has already been set in this session:
```python
def setup(posting: Posting) -> None:
if not posting.get_variable("auth_token"):
posting.set_variable("auth_token", "1234567890")
```
### Example: Pre-request script
The **pre-request script** is run after the request has been constructed and variables have been substituted, right before the request is sent.
You can directly modify the `RequestModel` object in this function, for example to set headers, query parameters, etc.
The code snippet below shows some of the API.
```python
from posting import Auth, Header, RequestModel, Posting
def on_request(request: RequestModel, posting: Posting) -> None:
# Add a custom header to the request.
request.headers.append(Header(name="X-Custom-Header", value="foo"))
# Set auth on the request.
request.auth = Auth.basic_auth("username", "password")
# request.auth = Auth.digest_auth("username", "password")
# request.auth = Auth.bearer_token_auth("token")
# This will be captured and written to the log.
print("Request is being sent!")
# Make a notification pop-up in the UI.
posting.notify("Request is being sent!")
```
### Example: Post-response script
The **post-response script** is run after the response is received.
You can use this to extract data from the response, for example a JWT token,
and set it as a variable to be used in later requests.
```python
from posting import Posting
def on_response(response: httpx.Response, posting: Posting) -> None:
# Print the status code of the response to the log.
print(response.status_code)
# Set a variable to be used in later requests.
# You can write '$auth_token' in the UI and it will be substituted with
# the value of the $auth_token variable.
posting.set_variable("auth_token", response.headers["Authorization"])
```
### The `Posting` object
The `Posting` object provides access to the application context and useful methods:
- `set_variable(name: str, value: object) -> None`: Set a session variable
- `get_variable(name: str, default: object | None = None) -> object | None`: Get a session variable
- `clear_variable(name: str) -> None`: Clear a specific session variable
- `clear_all_variables() -> None`: Clear all session variables
- `notify(message: str, title: str = "", severity: str = "information", timeout: float | None = None)`: Send a notification to the user
Note that variables are described as "session variables" because they persist for the duration of the session (until you close Posting).
### Execution environment
Scripts run in the same process and environment as Posting, so you should take care to avoid performing damaging global operations such as monkey-patching standard library modules.
#### Libraries
You can make use of any library that is available in the Python environment that Posting is running in. This means you can use all of the Python standard library as well as any of Posting's dependencies (such as `httpx`, `pyyaml`, `pydantic`, etc).
If you install Posting with `uv`, you can easily add extra dependencies which you can then use in your scripts:
```bash
uv tool install posting --with The API client that lives in your terminal.
Posting is a beautiful open-source terminal app for developing and testing APIs.
Fly through your API workflow with an approachable yet powerful keyboard-centric interface. Run it locally or over SSH on remote machines and containers. Save your requests in a readable and version-control friendly format.
Designed for efficient workflows
Navigate intuitively and efficiently with the keyboard using jump mode.
Access commands from anywhere using the built-in command palette.
Build requests quickly with powerful autocompletion.
Edit a request body in nvim or browse a JSON response in fx? No problem!
Import curl commands into Posting by simply pasting into the URL bar. Export requests to curl in seconds.
Colorful & customizable
Use compact mode to fit more on screen.
Create your own themes, or choose from a selection of built-in options.
Gorgeous syntax highlighting powered by the popular tree-sitter library.
Adjust the user interface to your liking through the configuration system or at runtime.
Customize keybindings to your liking using the keymap system.
Environments
Share common data across requests and with others using environments.
Load variables from one or more dotenv environment files, or allow access to environment variables.
Edit variables in your favorite editor, and Posting will hot reload them.
Contextual help
Feeling lost? Press f1 to learn keybindings and other useful information for the currently focused widget.
Scripting
Run Python code before and after requests to prepare headers, set variables, and more.
Runs where you need it
Run it on macOS, Windows, and Linux. Install it locally, on a remote server, in a Docker container, or even on a Raspberry Pi.
Community
Posting is a community-driven project with an open roadmap.
The roadmap is highly influenced by user feedback.
Get involved on GitHub by reporting bugs, suggesting features, sponsoring development, or contributing code.
User Interface improvements
UICollection management
CollectionEnvironment handling
EnvironmentAuthentication methods
AuthImport capabilities
ImportScripting capabilities
ScriptingDocumentation
DocumentationUser Experience
UXRequests
RequestsTesting capabilities
TestingSecurity features
SecurityLogging capabilities
LoggingPosting Snapshot Tests
Showing diffs for {{ fails }} mismatched snapshot(s)
{{ diffs | length }} snapshots changed
·
{{ passes }} snapshots matched
{{ diff.test_name }}
{{ diff.path }}:{{ diff.line_number }}
{% if diff.snapshot != "" %}
{% endif %}
{{ diff.actual }}
{{ diff.docstring }}
{% if diff.snapshot != "" %}
{{ diff.snapshot }}
{% else %}
{% endif %}
{% if diff.snapshot != "" %}
No history for this test
If you're happy with the content on the left,
save it to disk by running pytest with the --snapshot-update flag.
Unexpected?
Snapshots are named after the name of the test you call snap_compare in by default.
If you've renamed a test, the association between the snapshot and the test is lost,
and you'll need to run with --snapshot-update to associate the snapshot
with the new test name.
Historical snapshot
{% endif %}
If you're happy with the test output, run pytest with the --snapshot-update flag to update the snapshot.
Report generated at UTC {{ now }}.
![](\"https://run.pstmn.io/button.svg\")
](https://god.gw.postman.com/run-collection/10131015-0d9c66b3-5f1a-42ed-a5ca-379217bd629d?action=collection/fork)\n\n### Step 2: Get your API Access Key\n\n1. Go to the [Fixer](https://fixer.io/?utm_source=Postman&utm_medium=Referral) website and choose the right subscription plan for your particular project.\n \n2. Get your personal API Access Key on the [Dashboard](https://fixer.io/dashboard) to authenticate with the API. Keep it safe! You can reset it at any time in your Account Dashboard.\n \n\n## Step 3: Make your first API call\n\nFixer Postman collection contains all the endpoints supported by Fixer API.\n\n1. Symbols\n \n2. Latest Rates\n \n3. Historical Rates\n \n4. Specific Symbols\n \n5. Change Base Currency\n \n6. Covert\n \n7. Time Series\n \n8. Fluctuations\n \n\nWe recommend you to start with the `Latest Rates` endpoint to get the latest rates of mentioned currency according to the base currency (EUR) or mentioned currency.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "64221",
"_collection_link": "https://www.postman.com/apilayer/apilayer/collection/xvuply8/fixer?action=share&source=collection_link&creator=64221"
},
"item": [
{
"name": "Symbols",
"item": [
{
"name": "Currencies List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/symbols",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"symbols"
]
},
"description": "Fixer API's symbol endpoint returns a list of all the available currencies."
},
"response": [
{
"name": "200 OK – Currencies List",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/symbols?access_key={PASTE_YOUR_API_KEY_HERE}",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"symbols"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 14:00:03 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "a5c6d110-b57a-4605-b6bc-da902592c621"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "etag",
"value": "4a9cb6879f6edec160d789bd9905b4f8"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.006"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"symbols\": {\n \"AED\": \"United Arab Emirates Dirham\",\n \"AFN\": \"Afghan Afghani\",\n \"ALL\": \"Albanian Lek\",\n \"AMD\": \"Armenian Dram\",\n \"ANG\": \"Netherlands Antillean Guilder\",\n \"AOA\": \"Angolan Kwanza\",\n \"ARS\": \"Argentine Peso\",\n \"AUD\": \"Australian Dollar\",\n \"AWG\": \"Aruban Florin\",\n \"AZN\": \"Azerbaijani Manat\",\n \"BAM\": \"Bosnia-Herzegovina Convertible Mark\",\n \"BBD\": \"Barbadian Dollar\",\n \"BDT\": \"Bangladeshi Taka\",\n \"BGN\": \"Bulgarian Lev\",\n \"BHD\": \"Bahraini Dinar\",\n \"BIF\": \"Burundian Franc\",\n \"BMD\": \"Bermudan Dollar\",\n \"BND\": \"Brunei Dollar\",\n \"BOB\": \"Bolivian Boliviano\",\n \"BRL\": \"Brazilian Real\",\n \"BSD\": \"Bahamian Dollar\",\n \"BTC\": \"Bitcoin\",\n \"BTN\": \"Bhutanese Ngultrum\",\n \"BWP\": \"Botswanan Pula\",\n \"BYN\": \"New Belarusian Ruble\",\n \"BYR\": \"Belarusian Ruble\",\n \"BZD\": \"Belize Dollar\",\n \"CAD\": \"Canadian Dollar\",\n \"CDF\": \"Congolese Franc\",\n \"CHF\": \"Swiss Franc\",\n \"CLF\": \"Chilean Unit of Account (UF)\",\n \"CLP\": \"Chilean Peso\",\n \"CNY\": \"Chinese Yuan\",\n \"COP\": \"Colombian Peso\",\n \"CRC\": \"Costa Rican Colón\",\n \"CUC\": \"Cuban Convertible Peso\",\n \"CUP\": \"Cuban Peso\",\n \"CVE\": \"Cape Verdean Escudo\",\n \"CZK\": \"Czech Republic Koruna\",\n \"DJF\": \"Djiboutian Franc\",\n \"DKK\": \"Danish Krone\",\n \"DOP\": \"Dominican Peso\",\n \"DZD\": \"Algerian Dinar\",\n \"EGP\": \"Egyptian Pound\",\n \"ERN\": \"Eritrean Nakfa\",\n \"ETB\": \"Ethiopian Birr\",\n \"EUR\": \"Euro\",\n \"FJD\": \"Fijian Dollar\",\n \"FKP\": \"Falkland Islands Pound\",\n \"GBP\": \"British Pound Sterling\",\n \"GEL\": \"Georgian Lari\",\n \"GGP\": \"Guernsey Pound\",\n \"GHS\": \"Ghanaian Cedi\",\n \"GIP\": \"Gibraltar Pound\",\n \"GMD\": \"Gambian Dalasi\",\n \"GNF\": \"Guinean Franc\",\n \"GTQ\": \"Guatemalan Quetzal\",\n \"GYD\": \"Guyanaese Dollar\",\n \"HKD\": \"Hong Kong Dollar\",\n \"HNL\": \"Honduran Lempira\",\n \"HRK\": \"Croatian Kuna\",\n \"HTG\": \"Haitian Gourde\",\n \"HUF\": \"Hungarian Forint\",\n \"IDR\": \"Indonesian Rupiah\",\n \"ILS\": \"Israeli New Sheqel\",\n \"IMP\": \"Manx pound\",\n \"INR\": \"Indian Rupee\",\n \"IQD\": \"Iraqi Dinar\",\n \"IRR\": \"Iranian Rial\",\n \"ISK\": \"Icelandic Króna\",\n \"JEP\": \"Jersey Pound\",\n \"JMD\": \"Jamaican Dollar\",\n \"JOD\": \"Jordanian Dinar\",\n \"JPY\": \"Japanese Yen\",\n \"KES\": \"Kenyan Shilling\",\n \"KGS\": \"Kyrgystani Som\",\n \"KHR\": \"Cambodian Riel\",\n \"KMF\": \"Comorian Franc\",\n \"KPW\": \"North Korean Won\",\n \"KRW\": \"South Korean Won\",\n \"KWD\": \"Kuwaiti Dinar\",\n \"KYD\": \"Cayman Islands Dollar\",\n \"KZT\": \"Kazakhstani Tenge\",\n \"LAK\": \"Laotian Kip\",\n \"LBP\": \"Lebanese Pound\",\n \"LKR\": \"Sri Lankan Rupee\",\n \"LRD\": \"Liberian Dollar\",\n \"LSL\": \"Lesotho Loti\",\n \"LTL\": \"Lithuanian Litas\",\n \"LVL\": \"Latvian Lats\",\n \"LYD\": \"Libyan Dinar\",\n \"MAD\": \"Moroccan Dirham\",\n \"MDL\": \"Moldovan Leu\",\n \"MGA\": \"Malagasy Ariary\",\n \"MKD\": \"Macedonian Denar\",\n \"MMK\": \"Myanma Kyat\",\n \"MNT\": \"Mongolian Tugrik\",\n \"MOP\": \"Macanese Pataca\",\n \"MRU\": \"Mauritanian Ouguiya\",\n \"MUR\": \"Mauritian Rupee\",\n \"MVR\": \"Maldivian Rufiyaa\",\n \"MWK\": \"Malawian Kwacha\",\n \"MXN\": \"Mexican Peso\",\n \"MYR\": \"Malaysian Ringgit\",\n \"MZN\": \"Mozambican Metical\",\n \"NAD\": \"Namibian Dollar\",\n \"NGN\": \"Nigerian Naira\",\n \"NIO\": \"Nicaraguan Córdoba\",\n \"NOK\": \"Norwegian Krone\",\n \"NPR\": \"Nepalese Rupee\",\n \"NZD\": \"New Zealand Dollar\",\n \"OMR\": \"Omani Rial\",\n \"PAB\": \"Panamanian Balboa\",\n \"PEN\": \"Peruvian Nuevo Sol\",\n \"PGK\": \"Papua New Guinean Kina\",\n \"PHP\": \"Philippine Peso\",\n \"PKR\": \"Pakistani Rupee\",\n \"PLN\": \"Polish Zloty\",\n \"PYG\": \"Paraguayan Guarani\",\n \"QAR\": \"Qatari Rial\",\n \"RON\": \"Romanian Leu\",\n \"RSD\": \"Serbian Dinar\",\n \"RUB\": \"Russian Ruble\",\n \"RWF\": \"Rwandan Franc\",\n \"SAR\": \"Saudi Riyal\",\n \"SBD\": \"Solomon Islands Dollar\",\n \"SCR\": \"Seychellois Rupee\",\n \"SDG\": \"South Sudanese Pound\",\n \"SEK\": \"Swedish Krona\",\n \"SGD\": \"Singapore Dollar\",\n \"SHP\": \"Saint Helena Pound\",\n \"SLE\": \"Sierra Leonean Leone\",\n \"SLL\": \"Sierra Leonean Leone\",\n \"SOS\": \"Somali Shilling\",\n \"SRD\": \"Surinamese Dollar\",\n \"STD\": \"São Tomé and Príncipe Dobra\",\n \"SVC\": \"Salvadoran Colón\",\n \"SYP\": \"Syrian Pound\",\n \"SZL\": \"Swazi Lilangeni\",\n \"THB\": \"Thai Baht\",\n \"TJS\": \"Tajikistani Somoni\",\n \"TMT\": \"Turkmenistani Manat\",\n \"TND\": \"Tunisian Dinar\",\n \"TOP\": \"Tongan Paʻanga\",\n \"TRY\": \"Turkish Lira\",\n \"TTD\": \"Trinidad and Tobago Dollar\",\n \"TWD\": \"New Taiwan Dollar\",\n \"TZS\": \"Tanzanian Shilling\",\n \"UAH\": \"Ukrainian Hryvnia\",\n \"UGX\": \"Ugandan Shilling\",\n \"USD\": \"United States Dollar\",\n \"UYU\": \"Uruguayan Peso\",\n \"UZS\": \"Uzbekistan Som\",\n \"VEF\": \"Venezuelan Bolívar Fuerte\",\n \"VES\": \"Sovereign Bolivar\",\n \"VND\": \"Vietnamese Dong\",\n \"VUV\": \"Vanuatu Vatu\",\n \"WST\": \"Samoan Tala\",\n \"XAF\": \"CFA Franc BEAC\",\n \"XAG\": \"Silver (troy ounce)\",\n \"XAU\": \"Gold (troy ounce)\",\n \"XCD\": \"East Caribbean Dollar\",\n \"XDR\": \"Special Drawing Rights\",\n \"XOF\": \"CFA Franc BCEAO\",\n \"XPF\": \"CFP Franc\",\n \"YER\": \"Yemeni Rial\",\n \"ZAR\": \"South African Rand\",\n \"ZMK\": \"Zambian Kwacha (pre-2013)\",\n \"ZMW\": \"Zambian Kwacha\",\n \"ZWL\": \"Zimbabwean Dollar\"\n }\n}"
}
]
}
],
"description": "The Fixer API comes with a constantly updated endpoint returning all available currencies. To access this list, make a request to the API's `symbols` endpoint."
},
{
"name": "Latest Rates",
"item": [
{
"name": "Latest Rates of single currency",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?base=USD&symbols=INR",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
},
{
"key": "symbols",
"value": "INR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
},
"description": "Depending on your subscription plan, the API's `latest` endpoint will return real-time exchange rate data updated every 60 minutes, every 10 minutes or every 60 seconds."
},
"response": [
{
"name": "200 OK – Latest Rates of single currency",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?access_key={PASTE_YOUR_API_KEY_HERE}&base=USD&symbols=INR",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
},
{
"key": "symbols",
"value": "INR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 14:03:11 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "9990df89-64fb-458b-9066-4584933dabb4"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "last-modified",
"value": "Tue, 19 Mar 2024 14:03:03 GMT"
},
{
"key": "etag",
"value": "9dcd85a6be21bd44feb86dd73b6caa77"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.011"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"timestamp\": 1710856983,\n \"base\": \"USD\",\n \"date\": \"2024-03-19\",\n \"rates\": {\n \"INR\": 83.01835\n }\n}"
}
]
},
{
"name": "Latest Rates of multiple currency",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest? base=USD&symbols=GBP,JPY,EUR",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": " base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
},
{
"key": "symbols",
"value": "GBP,JPY,EUR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
},
"description": "Depending on your subscription plan, the API's `latest` endpoint will return real-time exchange rate data updated every 60 minutes, every 10 minutes or every 60 seconds."
},
"response": [
{
"name": "200 OK – Latest Rates of multiple currency",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?access_key={PASTE_YOUR_API_KEY_HERE}& base=USD&symbols=GBP,JPY,EUR",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": " base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
},
{
"key": "symbols",
"value": "GBP,JPY,EUR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 14:05:44 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "5a51d227-c08d-4f41-ae81-1a23e57e951d"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "last-modified",
"value": "Tue, 19 Mar 2024 14:05:04 GMT"
},
{
"key": "etag",
"value": "bfb246e3eff6608cdfa4249e33e640d6"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.009"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"timestamp\": 1710857104,\n \"base\": \"USD\",\n \"date\": \"2024-03-19\",\n \"rates\": {\n \"GBP\": 0.78741,\n \"JPY\": 150.687984,\n \"EUR\": 0.921205\n }\n}"
}
]
}
],
"description": "Fixer API's `latest` endpoint will return real-time exchange rate data updated every 60 minutes, every 10 minutes or every 60 seconds."
},
{
"name": "Historial Rates",
"item": [
{
"name": "Historical Rates",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/2013-12-24?base=USD&symbols=INR",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"2013-12-24"
],
"query": [
{
"key": "base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
},
{
"key": "symbols",
"value": "INR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
},
"description": "Historical rates are available for most currencies all the way back to the year of 1999. You can query the Fixer API for historical rates by appending a date (format `YYYY-MM-DD`) to the base URL."
},
"response": [
{
"name": "200 OK – Historical Rates",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/2013-12-24?access_key={PASTE_YOUR_API_KEY_HERE}&base=USD&symbols=INR",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"2013-12-24"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
},
{
"key": "symbols",
"value": "INR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 14:14:42 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "4605c076-2696-4f3e-ad29-0ce88b287730"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "last-modified",
"value": "Tue, 24 Dec 2013 23:59:59 GMT"
},
{
"key": "etag",
"value": "7e79f2cfe912da36f23083f8660dd68f"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.011"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"timestamp\": 1387929599,\n \"historical\": true,\n \"base\": \"USD\",\n \"date\": \"2013-12-24\",\n \"rates\": {\n \"INR\": 61.78381\n }\n}"
}
]
}
],
"description": "Historical rates are available for most currencies all the way back to the year of 1999. You can query the Fixer API for historical rates by appending a date (format `YYYY-MM-DD`) to the base URL."
},
{
"name": "Specific Symbols",
"item": [
{
"name": "Specific Currencies Rate",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?symbols=USD,CAD,JPY",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "symbols",
"value": "USD,CAD,JPY",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
},
"description": "To reduce bandwidth you can limit the number of output currencies to a specific set of your choice on most API endpoints. To do so, simply append the Fixer API's `symbols` parameter to your API request and set it to one or more comma-separated currency codes."
},
"response": [
{
"name": "200 OK – Specific Currencies Rates",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?access_key={PASTE_YOUR_API_KEY_HERE}&symbols=USD,CAD,JPY",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "symbols",
"value": "USD,CAD,JPY",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 14:17:41 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "ac193b46-01ee-480a-b211-80df06c8d996"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "last-modified",
"value": "Tue, 19 Mar 2024 14:17:04 GMT"
},
{
"key": "etag",
"value": "b64fe09c440d652171991e6adef38427"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.009"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"timestamp\": 1710857824,\n \"base\": \"EUR\",\n \"date\": \"2024-03-19\",\n \"rates\": {\n \"USD\": 1.086124,\n \"CAD\": 1.477482,\n \"JPY\": 163.643091\n }\n}"
}
]
}
],
"description": "To reduce bandwidth you can limit the number of output currencies to a specific set of your choice on most API endpoints. To do so, simply append the Fixer API's `symbols` parameter to your API request and set it to one or more comma-separated currency codes."
},
{
"name": "Change Base Currency",
"item": [
{
"name": "Change base currency",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?base=USD",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
}
]
},
"description": "You can change the currency to which your output currency rates are relative to by appending the `base` parameter to your API request URL and setting it to the three-letter code of your preferred base currency."
},
"response": [
{
"name": "200 OK – Change base currency",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/latest?access_key={PASTE_YOUR_API_KEY_HERE}&base=USD",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"latest"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "base",
"value": "USD",
"description": "[optional] Enter the three-letter currency code of your preferred base currency.\n"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 15:34:22 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "74ba3ad2-a2dc-4a66-bf23-4ac6ff5b1996"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "last-modified",
"value": "Tue, 19 Mar 2024 15:34:05 GMT"
},
{
"key": "etag",
"value": "5d424e42a6b7b264261d0717209dc7e3"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.012"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"timestamp\": 1710862445,\n \"base\": \"USD\",\n \"date\": \"2024-03-19\",\n \"rates\": {\n \"AED\": 3.672403,\n \"AFN\": 71.265629,\n \"ALL\": 95.213955,\n \"AMD\": 402.331958,\n \"ANG\": 1.802429,\n \"AOA\": 832.633032,\n \"ARS\": 852.753905,\n \"AUD\": 1.531394,\n \"AWG\": 1.8,\n \"AZN\": 1.697294,\n \"BAM\": 1.802655,\n \"BBD\": 2.019254,\n \"BDT\": 109.75621,\n \"BGN\": 1.801798,\n \"BHD\": 0.376877,\n \"BIF\": 2860.592654,\n \"BMD\": 1,\n \"BND\": 1.342089,\n \"BOB\": 6.911077,\n \"BRL\": 5.025199,\n \"BSD\": 1.000041,\n \"BTC\": 0.000015759735,\n \"BTN\": 83.028596,\n \"BWP\": 13.718541,\n \"BYN\": 3.272317,\n \"BYR\": 19600,\n \"BZD\": 2.015844,\n \"CAD\": 1.359035,\n \"CDF\": 2773.000062,\n \"CHF\": 0.88837,\n \"CLF\": 0.034982,\n \"CLP\": 965.200977,\n \"CNY\": 7.199298,\n \"COP\": 3892.29,\n \"CRC\": 502.799733,\n \"CUC\": 1,\n \"CUP\": 26.5,\n \"CVE\": 101.630943,\n \"CZK\": 23.286604,\n \"DJF\": 178.091156,\n \"DKK\": 6.869699,\n \"DOP\": 59.027122,\n \"DZD\": 134.599405,\n \"EGP\": 47.050201,\n \"ERN\": 15,\n \"ETB\": 56.799779,\n \"EUR\": 0.92124,\n \"FJD\": 2.26815,\n \"FKP\": 0.78544,\n \"GBP\": 0.78712,\n \"GEL\": 2.679878,\n \"GGP\": 0.78544,\n \"GHS\": 13.018411,\n \"GIP\": 0.78544,\n \"GMD\": 67.92498,\n \"GNF\": 8596.709526,\n \"GTQ\": 7.800539,\n \"GYD\": 209.452266,\n \"HKD\": 7.822065,\n \"HNL\": 24.695033,\n \"HRK\": 6.882375,\n \"HTG\": 132.586144,\n \"HUF\": 363.670971,\n \"IDR\": 15740.8,\n \"ILS\": 3.67315,\n \"IMP\": 0.78544,\n \"INR\": 83.02555,\n \"IQD\": 1310.106457,\n \"IRR\": 42034.999801,\n \"ISK\": 137.179945,\n \"JEP\": 0.78544,\n \"JMD\": 154.093601,\n \"JOD\": 0.7089,\n \"JPY\": 150.775991,\n \"KES\": 132.497187,\n \"KGS\": 89.510254,\n \"KHR\": 4048.094161,\n \"KMF\": 452.950526,\n \"KPW\": 899.97938,\n \"KRW\": 1338.929755,\n \"KWD\": 0.30751,\n \"KYD\": 0.833399,\n \"KZT\": 451.753537,\n \"LAK\": 20925.870452,\n \"LBP\": 89558.264396,\n \"LKR\": 303.977142,\n \"LRD\": 192.649748,\n \"LSL\": 18.949797,\n \"LTL\": 2.95274,\n \"LVL\": 0.60489,\n \"LYD\": 4.820476,\n \"MAD\": 10.046777,\n \"MDL\": 17.726571,\n \"MGA\": 4495.241607,\n \"MKD\": 56.761599,\n \"MMK\": 2100.17927,\n \"MNT\": 3400.292164,\n \"MOP\": 8.058437,\n \"MRU\": 39.914989,\n \"MUR\": 46.08936,\n \"MVR\": 15.405027,\n \"MWK\": 1683.526511,\n \"MXN\": 16.86776,\n \"MYR\": 4.732997,\n \"MZN\": 63.499756,\n \"NAD\": 18.969783,\n \"NGN\": 1477.249886,\n \"NIO\": 36.803539,\n \"NOK\": 10.647498,\n \"NPR\": 132.846049,\n \"NZD\": 1.65241,\n \"OMR\": 0.384942,\n \"PAB\": 1.000041,\n \"PEN\": 3.70127,\n \"PGK\": 3.769742,\n \"PHP\": 55.921979,\n \"PKR\": 278.65069,\n \"PLN\": 3.98115,\n \"PYG\": 7303.730673,\n \"QAR\": 3.64075,\n \"RON\": 4.582198,\n \"RSD\": 107.992059,\n \"RUB\": 91.449759,\n \"RWF\": 1284.200727,\n \"SAR\": 3.75034,\n \"SBD\": 8.475185,\n \"SCR\": 13.543068,\n \"SDG\": 585.999997,\n \"SEK\": 10.44705,\n \"SGD\": 1.34213,\n \"SHP\": 1.272979,\n \"SLE\": 22.592355,\n \"SLL\": 22592.354936,\n \"SOS\": 571.50088,\n \"SRD\": 35.2385,\n \"STD\": 20697.981008,\n \"SVC\": 8.750593,\n \"SYP\": 13001.807992,\n \"SZL\": 18.976911,\n \"THB\": 36.08031,\n \"TJS\": 10.970989,\n \"TMT\": 3.51,\n \"TND\": 3.10275,\n \"TOP\": 2.368982,\n \"TRY\": 32.344298,\n \"TTD\": 6.788488,\n \"TWD\": 31.793503,\n \"TZS\": 2549.999971,\n \"UAH\": 39.157384,\n \"UGX\": 3880.345268,\n \"USD\": 1,\n \"UYU\": 38.471642,\n \"UZS\": 12562.733017,\n \"VEF\": 3624928.073833,\n \"VES\": 36.219996,\n \"VND\": 24750,\n \"VUV\": 119.91961,\n \"WST\": 2.751039,\n \"XAF\": 604.593739,\n \"XAG\": 0.040067,\n \"XAU\": 0.000464,\n \"XCD\": 2.70255,\n \"XDR\": 0.751002,\n \"XOF\": 604.593739,\n \"XPF\": 110.15002,\n \"YER\": 250.349832,\n \"ZAR\": 18.936703,\n \"ZMK\": 9001.186468,\n \"ZMW\": 25.727124,\n \"ZWL\": 321.999592\n }\n}"
}
]
}
],
"description": "Provided changing base currency is supported on your subscription plan, you can change the currency to which your output currency rates are relative to by appending the `base` parameter to your API request URL and setting it to the three-letter code of your preferred base currency.\n\nCheck out the basic GET request inside this folder."
},
{
"name": "Convert",
"item": [
{
"name": "Convert according to latest rates",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/convert?from=USD&to=INR&amount=100",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"convert"
],
"query": [
{
"key": "from",
"value": "USD",
"description": "[required] The three-letter currency code of the currency you would like to convert from.\n"
},
{
"key": "to",
"value": "INR"
},
{
"key": "amount",
"value": "100",
"description": "[required] The amount to be converted.\n"
}
]
},
"description": "Using `convert` endpoint, you can convert any amount from one currency to another based on the latest rates or historical rates."
},
"response": [
{
"name": "200 OK – Convert according to latest rates",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/convert?access_key={PASTE_YOUR_API_KEY_HERE}&from=USD& to=INR&amount=100",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"convert"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "from",
"value": "USD",
"description": "[required] The three-letter currency code of the currency you would like to convert from.\n"
},
{
"key": " to",
"value": "INR",
"description": "[required] The three-letter currency code of the currency you would like to convert to.\n"
},
{
"key": "amount",
"value": "100",
"description": "[optional] Specify a date (format YYYY-MM-DD) to use historical rates for this conversion."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 15:39:22 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "b67084af-3ba9-4ebf-814e-659abe3a918b"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "etag",
"value": "2fea930f725fa93e65644694c9f201e3"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.009"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"query\": {\n \"from\": \"USD\",\n \"to\": \"INR\",\n \"amount\": 100\n },\n \"info\": {\n \"timestamp\": 1710862743,\n \"rate\": 83.01935\n },\n \"date\": \"2024-03-19\",\n \"result\": 8301.935\n}"
}
]
},
{
"name": "Convert according to historical rates",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/convert?from=USD&to=INR&amount=100&date=1999-08-14",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"convert"
],
"query": [
{
"key": "from",
"value": "USD",
"description": "[required] The three-letter currency code of the currency you would like to convert from.\n"
},
{
"key": "to",
"value": "INR"
},
{
"key": "amount",
"value": "100",
"description": "[required] The amount to be converted.\n"
},
{
"key": "date",
"value": "1999-08-14",
"description": "[optional] Specify a date (format YYYY-MM-DD) to use historical rates for this conversion."
}
]
},
"description": "Using `convert` endpoint, you can convert any amount from one currency to another based on the latest rates or historical rates."
},
"response": [
{
"name": "200 OK – Convert according to historical rates",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/convert?access_key={PASTE_YOUR_API_KEY_HERE}&from=USD&to=INR&amount=100&date=1999-08-14",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"convert"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "from",
"value": "USD",
"description": "[required] The three-letter currency code of the currency you would like to convert from.\n"
},
{
"key": "to",
"value": "INR"
},
{
"key": "amount",
"value": "100",
"description": "[required] The amount to be converted.\n"
},
{
"key": "date",
"value": "1999-08-14",
"description": "[optional] Specify a date (format YYYY-MM-DD) to use historical rates for this conversion."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 15:46:03 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "7638dccc-aa07-4070-9ee6-f288d7ee2a73"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "etag",
"value": "b15df7337e33b47189142eb5b5ddf689"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.008"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"query\": {\n \"from\": \"USD\",\n \"to\": \"INR\",\n \"amount\": 100\n },\n \"info\": {\n \"timestamp\": 934675199,\n \"rate\": 43.49913\n },\n \"date\": \"1999-08-14\",\n \"historical\": true,\n \"result\": 4349.913\n}"
}
]
}
],
"description": "The Fixer API comes with a separate currency conversion endpoint, which can be used to convert any amount from one currency to another. In order to convert currencies, please use the API's `convert` endpoint, append the `from` and `to` parameters and set them to your preferred base and target currency codes.\n\nIt is also possible to convert currencies using historical exchange rate data. To do this, please also use the API's `date parameter` and set it to your preferred date. (format `YYYY-MM-DD`)"
},
{
"name": "Time Series",
"item": [
{
"name": "Rates b/w two dates",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/timeseries?symbols=USD,EUR&start_date=2012-05-01&end_date=2012-05-25",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"timeseries"
],
"query": [
{
"key": "symbols",
"value": "USD,EUR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
},
{
"key": "start_date",
"value": "2012-05-01",
"description": "[required] The start date of your preferred timeframe.\n"
},
{
"key": "end_date",
"value": "2012-05-25",
"description": "[required] The end date of your preferred timeframe.\n"
}
]
},
"description": "If supported by your subscription plan, the Fixer API's `timeseries` endpoint lets you query the API for daily historical rates between two dates of your choice, with a maximum time frame of 365 days."
},
"response": [
{
"name": "200 OK – Rates b/w two dates",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/timeseries?access_key={PASTE_YOUR_API_KEY_HERE}&symbols=USD,EUR&start_date=2012-05-01&end_date=2012-05-25",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"timeseries"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "symbols",
"value": "USD,EUR",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
},
{
"key": "start_date",
"value": "2012-05-01",
"description": "[required] The start date of your preferred timeframe.\n"
},
{
"key": "end_date",
"value": "2012-05-25",
"description": "[required] The end date of your preferred timeframe.\n"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 15:48:57 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "5cf8855e-8d3d-4ebc-9882-555f23ca8b41"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "etag",
"value": "2f4fba675530a12a97b6529e13623687"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.038"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"timeseries\": true,\n \"start_date\": \"2012-05-01\",\n \"end_date\": \"2012-05-25\",\n \"base\": \"EUR\",\n \"rates\": {\n \"2012-05-01\": {\n \"USD\": 1.322891,\n \"EUR\": 1\n },\n \"2012-05-02\": {\n \"USD\": 1.315066,\n \"EUR\": 1\n },\n \"2012-05-03\": {\n \"USD\": 1.314491,\n \"EUR\": 1\n },\n \"2012-05-04\": {\n \"USD\": 1.309598,\n \"EUR\": 1\n },\n \"2012-05-05\": {\n \"USD\": 1.310795,\n \"EUR\": 1\n },\n \"2012-05-06\": {\n \"USD\": 1.310795,\n \"EUR\": 1\n },\n \"2012-05-07\": {\n \"USD\": 1.305192,\n \"EUR\": 1\n },\n \"2012-05-08\": {\n \"USD\": 1.301463,\n \"EUR\": 1\n },\n \"2012-05-09\": {\n \"USD\": 1.294599,\n \"EUR\": 1\n },\n \"2012-05-10\": {\n \"USD\": 1.295035,\n \"EUR\": 1\n },\n \"2012-05-11\": {\n \"USD\": 1.293056,\n \"EUR\": 1\n },\n \"2012-05-12\": {\n \"USD\": 1.293268,\n \"EUR\": 1\n },\n \"2012-05-13\": {\n \"USD\": 1.293268,\n \"EUR\": 1\n },\n \"2012-05-14\": {\n \"USD\": 1.284365,\n \"EUR\": 1\n },\n \"2012-05-15\": {\n \"USD\": 1.276179,\n \"EUR\": 1\n },\n \"2012-05-16\": {\n \"USD\": 1.272686,\n \"EUR\": 1\n },\n \"2012-05-17\": {\n \"USD\": 1.269783,\n \"EUR\": 1\n },\n \"2012-05-18\": {\n \"USD\": 1.273209,\n \"EUR\": 1\n },\n \"2012-05-19\": {\n \"USD\": 1.274101,\n \"EUR\": 1\n },\n \"2012-05-20\": {\n \"USD\": 1.274101,\n \"EUR\": 1\n },\n \"2012-05-21\": {\n \"USD\": 1.278812,\n \"EUR\": 1\n },\n \"2012-05-22\": {\n \"USD\": 1.271223,\n \"EUR\": 1\n },\n \"2012-05-23\": {\n \"USD\": 1.25921,\n \"EUR\": 1\n },\n \"2012-05-24\": {\n \"USD\": 1.255457,\n \"EUR\": 1\n },\n \"2012-05-25\": {\n \"USD\": 1.252213,\n \"EUR\": 1\n }\n }\n}"
}
]
}
],
"description": "If supported by your subscription plan, the Fixer API's `timeseries` endpoint lets you query the API for daily historical rates between two dates of your choice, with a maximum time frame of 365 days."
},
{
"name": "Fluctuation",
"item": [
{
"name": "Fluctuation b/w two dates",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/fluctuation?symbols=USD&start_date=2015-12-01&end_date=2016-05-24",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"fluctuation"
],
"query": [
{
"key": "symbols",
"value": "USD",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
},
{
"key": "start_date",
"value": "2015-12-01",
"description": "[required] The start date of your preferred fluctuation timeframe.\n"
},
{
"key": "end_date",
"value": "2016-05-24",
"description": "[required] The end date of your preferred fluctuation timeframe.\n"
}
]
},
"description": "Using the Fixer API's `fluctuation` endpoint you will be able to retrieve information about how currencies fluctuate on a day-to-day basis. To use this feature, simply append a `start_date` and `end_date` and choose which currencies (symbols) you would like to query the API for. Please note that the maximum allowed timeframe is 365 days."
},
"response": [
{
"name": "200 OK – Fluctuation b/w two dates",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "https://data.fixer.io/api/fluctuation?access_key={PASTE_YOUR_API_KEY_HERE}&symbols=USD&start_date=2015-12-01&end_date=2016-05-24",
"protocol": "https",
"host": [
"data",
"fixer",
"io"
],
"path": [
"api",
"fluctuation"
],
"query": [
{
"key": "access_key",
"value": "{PASTE_YOUR_API_KEY_HERE}",
"description": "[Required] Specify your API access key, available in your account dashboard.\n"
},
{
"key": "symbols",
"value": "USD",
"description": "[optional] Enter a list of comma-separated currency codes to limit output currencies."
},
{
"key": "start_date",
"value": "2015-12-01",
"description": "[required] The start date of your preferred fluctuation timeframe.\n"
},
{
"key": "end_date",
"value": "2016-05-24",
"description": "[required] The end date of your preferred fluctuation timeframe.\n"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "date",
"value": "Tue, 19 Mar 2024 15:54:46 GMT"
},
{
"key": "content-type",
"value": "application/json; Charset=UTF-8"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "x-apilayer-transaction-id",
"value": "e680afc7-8860-46b6-9e14-1e7006231134"
},
{
"key": "access-control-allow-methods",
"value": "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS"
},
{
"key": "etag",
"value": "0947f20b73d8c2f8133978d942911701"
},
{
"key": "access-control-allow-origin",
"value": "*"
},
{
"key": "x-request-time",
"value": "0.008"
}
],
"cookie": [],
"body": "{\n \"success\": true,\n \"fluctuation\": true,\n \"start_date\": \"2015-12-01\",\n \"end_date\": \"2016-05-24\",\n \"base\": \"EUR\",\n \"rates\": {\n \"USD\": {\n \"start_rate\": 1.062855,\n \"end_rate\": 1.114116,\n \"change\": 0.0513,\n \"change_pct\": 4.823\n }\n }\n}"
}
]
}
],
"description": "Using the Fixer API's `fluctuation` endpoint you will be able to retrieve information about how currencies fluctuate on a day-to-day basis. To use this feature, simply append a `start_date` and `end_date` and choose which currencies (symbols) you would like to query the API for. Please note that the maximum allowed timeframe is 365 days."
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "in",
"value": "query",
"type": "string"
},
{
"key": "value",
"value": "{{access_key}}",
"type": "string"
},
{
"key": "key",
"value": "access_key",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
],
"variable": [
{
"key": "access_key",
"value": "",
"type": "string"
}
]
}
================================================
FILE: tests/sample-importable-collections/postman_collection.json
================================================
{
"info": {
"_postman_id": "3ae89321-fd45-4694-880c-3081da4ef678",
"name": "Fastly API",
"description": "Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends; and configuring rules or uploading your own application code, as well as perform account operations such as user administration and billing reports.\n\nThe API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts.\n\nFor the most accurate and up-to-date API reference content, visit [developer.fastly.com/reference/api/](https://developer.fastly.com/reference/api/).",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "64221",
"_collection_link": "https://www.postman.com/fastly/fastly-developer-hub/collection/04544o5/fastly-api?action=share&source=collection_link&creator=64221"
},
"item": [
{
"name": "Account",
"item": [
{
"name": "Billing address",
"item": [
{
"name": "Get a billing address",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/billing_address",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"billing_address"
]
},
"description": "Get a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"billing_address"
]
},
"description": "Get a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"},\"relationships\":{\"customer\":{\"data\":{\"type\":\"customer\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}}}}}"
}
]
},
{
"name": "Add a billing address to a customer",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"skip_verification\":false,\"data\":{\"type\":\"billing_address\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"}}}"
},
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/billing_address",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"billing_address"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/billing-address/#add-billing-addr)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "201 Created",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"skip_verification\":false,\"data\":{\"type\":\"billing_address\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"}}}"
},
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"billing_address"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/billing-address/#add-billing-addr)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "201 Created",
"code": 201,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"},\"relationships\":{\"customer\":{\"data\":{\"type\":\"customer\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}}}}}"
}
]
},
{
"name": "Delete a billing address",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/billing_address",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"billing_address"
]
},
"description": "Delete a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"billing_address"
]
},
"description": "Delete a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Update a billing address",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"skip_verification\":false,\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"state\":\"DE\"}}}"
},
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/billing_address",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"billing_address"
]
},
"description": "Update a customer's billing address. You may update only part of the customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"skip_verification\":false,\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"state\":\"DE\"}}}"
},
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"billing_address"
]
},
"description": "Update a customer's billing address. You may update only part of the customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"},\"relationships\":{\"customer\":{\"data\":{\"type\":\"customer\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}}}}}"
}
]
}
],
"description": "A billing address is used to calculate your bill correctly.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address_1 | string | The first address line. |\n| address_2 | string | The second address line. |\n| city | string | The city name. |\n| country | string | ISO 3166-1 two-letter country code. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| locality | string | Other locality. |\n| postal_code | string | Postal code (ZIP code for US addresses). |\n| state | string | The state or province name. |\n| skip_verification | boolean | When set to true, the address will be saved without verification. |\n| type | string | Resource type. |\n| id | string | Alphanumeric string identifying the billing address. |\n| relationships.customer.id | string | Alphanumeric string identifying the customer. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Usage Metrics API",
"item": [
{
"name": "Retrieve service-level usage metrics for services with non-zero usage units",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/billing/v3/service-usage-metrics?cursor&end_month&limit&product_id&service&start_month&usage_type_name",
"host": [
"{{fastly_url}}"
],
"path": [
"billing",
"v3",
"service-usage-metrics"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "end_month",
"description": "The end month for metrics."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 10000."
},
{
"key": "product_id",
"description": "The product identifier for the metrics returned (e.g., cdn_usage). This should be used along with usage_type_name."
},
{
"key": "service",
"description": "The service identifier for the metrics being requested."
},
{
"key": "start_month",
"description": "The start month for metrics."
},
{
"key": "usage_type_name",
"description": "The usage type name for the metrics returned (e.g., North America Requests). This should be used along with product_id."
}
]
},
"description": "Returns product usage, broken down by service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 A response containing usage elements.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/billing/v3/service-usage-metrics?end_month=2023-03&start_month=2023-01?cursor&end_month&limit&product_id&service&start_month&usage_type_name",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"billing",
"v3",
"service-usage-metrics"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "end_month",
"description": "The end month for metrics."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 10000."
},
{
"key": "product_id",
"description": "The product identifier for the metrics returned (e.g., cdn_usage). This should be used along with usage_type_name."
},
{
"key": "service",
"description": "The service identifier for the metrics being requested."
},
{
"key": "start_month",
"description": "The start month for metrics."
},
{
"key": "usage_type_name",
"description": "The usage type name for the metrics returned (e.g., North America Requests). This should be used along with product_id."
}
]
},
"description": "Returns product usage, broken down by service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 A response containing usage elements.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"customer_id\":\"2fNwVYePN8WqqDFvVf7XMN\",\"start_time\":\"2023-01-01T00:00:00.000Z\",\"end_time\":\"2023-03-31T00:15:00.000Z\",\"usage_type\":\"\",\"unit\":\"\",\"details\":[{\"customer_id\":\"2fNwVYePN8WqqDFvVf7XMN\",\"service_id\":\"bptj4wc6VheGhOPN0Okjt5\",\"service_name\":\"Example Production Challenge Service Audio\",\"usage_units\":0.011197259,\"usage_type\":\"North_America_Bandwidth\",\"unit\":\"gb\"},{\"customer_id\":\"2fNwVYePN8WqqDFvVf7XMN\",\"service_id\":\"vpFdIXI0NmgoBSbbFbxbY4\",\"service_name\":\"Example Production Client Challenge Health Check Service\",\"usage_units\":369.108883208,\"usage_type\":\"North_America_Bandwidth\",\"unit\":\"gb\"},{\"customer_id\":\"2fNwVYePN8WqqDFvVf7XMN\",\"service_id\":\"GF4YOGOTsnGkRb6ydDbib4\",\"service_name\":\"Example Production Client Challenge Service A\",\"usage_units\":39.885526458,\"usage_type\":\"Asia_Requests\",\"unit\":\"unit\"},{\"customer_id\":\"2fNwVYePN8WqqDFvVf7XMN\",\"service_id\":\"hSzFGIm8kMN0HdiW7Ppdn3\",\"service_name\":\"Example Production Client Challenge Service B\",\"usage_units\":84.736532146,\"usage_type\":\"North_America_Requests\",\"unit\":\"unit\"},{\"customer_id\":\"2fNwVYePN8WqqDFvVf7XMN\",\"service_id\":\"dxlSF5cAWt2VcwitclfKL6\",\"service_name\":\"se--1xinternetgmbh--66558d4f3319eaad8bd98cae\",\"usage_units\":66.736532146,\"usage_type\":\"Africa_Bandwidth\",\"unit\":\"gb\"}]},\"meta\":{\"next_cursor\":\"MTC==\",\"limit\":5,\"sort\":\"service_name\",\"total\":142}}"
}
]
},
{
"name": "Get monthly usage metrics",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/billing/v3/usage-metrics?end_month&start_month",
"host": [
"{{fastly_url}}"
],
"path": [
"billing",
"v3",
"usage-metrics"
],
"query": [
{
"key": "end_month",
"description": "The end month for metrics."
},
{
"key": "start_month",
"description": "The start month for metrics."
}
]
},
"description": "Returns monthly usage metrics for customer by product.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 A response containing usage metric elements.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/billing/v3/usage-metrics?end_month=2024-06&start_month=2024-05?end_month&start_month",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"billing",
"v3",
"usage-metrics"
],
"query": [
{
"key": "end_month",
"description": "The end month for metrics."
},
{
"key": "start_month",
"description": "The start month for metrics."
}
]
},
"description": "Returns monthly usage metrics for customer by product.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 A response containing usage metric elements.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"month\":\"2024-07\",\"usage_type\":\"Other\",\"name\":\"Fastly TLS - Non-Profit CA / Bring Your Own Certificates\",\"region\":\"Global\",\"unit\":\"unit\",\"quantity\":2,\"raw_quantity\":2,\"product_id\":\"fastly_tls\",\"last_updated_at\":\"2024-08-01\"},{\"month\":\"2024-09\",\"usage_type\":\"Other\",\"name\":\"Fastly TLS - Non-Profit CA / Bring Your Own Certificates\",\"region\":\"Global\",\"unit\":\"unit\",\"quantity\":3,\"raw_quantity\":3,\"product_id\":\"fastly_tls\",\"last_updated_at\":\"2024-09-04\"}]}"
}
]
}
],
"description": "Get information on billing usage metrics.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| end_time | string | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. |\n| meta | object | Pagination metadata. |\n| start_time | string | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. |\n| unit | string | The unit for the usage as shown on an invoice. If there is no explicit unit, this field will be \"unit\" (e.g., a request with product_id of 'cdn_usage' and usage_type of 'North America Requests' has no unit, and will return \"unit\"). |\n| usage_type | string | The usage type identifier for the usage. This is a single, billable metric for the product. |\n| name | string | Full name of the product usage type as it might appear on a customer's invoice. |\n| product_id | string | The product identifier associated with the usage type. This corresponds to a Fastly product offering. |\n| limit | integer | The number of invoices included in the response. |\n| next_cursor | string | The token used to request the next set of results. |\n| sort | string | The sort order of the invoices in the response. |\n| total | integer | Total number of records available on the backend. |\n| last_updated_at | string | The date when the usage metric was last updated. |\n| month | string | The year and month of the usage element. |\n| quantity | number | The quantity of the usage for the product. |\n| raw_quantity | number | The raw units measured for the product. |\n| region | string | The geographical area applicable for regionally based products. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Customer Contact",
"item": [
{
"name": "List contacts",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/contacts",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"contacts"
]
},
"description": "List all contacts from a specified customer ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/contacts",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"contacts"
]
},
"description": "List all contacts from a specified customer ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"name\":null,\"email\":null,\"type\":\"security\",\"phone_number\":\"5555555559\",\"user_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"customer_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Add a new customer contact",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/contacts",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"contacts"
]
},
"description": "Create a contact.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/contacts",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"contacts"
]
},
"description": "Create a contact.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"name\":null,\"email\":null,\"type\":\"primary\",\"phone_number\":\"5555555559\",\"user_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"customer_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null,\"phone\":\"5555555555\"}"
}
]
},
{
"name": "Delete a contact",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/contacts/{{contact_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"contacts",
"{{contact_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/contact/#delete-contact)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/contacts/x4xCwxxJxGCx123Rx5xTx",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"contacts",
"x4xCwxxJxGCx123Rx5xTx"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/contact/#delete-contact)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "A Customer Contact is the base object that holds the different types of contact information Fastly uses to contact a customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| contact_type | string | The type of contact. |\n| customer_id | string | The alphanumeric string representing the customer for this customer contact. |\n| email | string | The email of this contact, when a user_id is not provided. |\n| name | string | The name of this contact, when user_id is not provided. |\n| phone | string | The phone number for this contact. Required for primary, technical, and security contact types. |\n| user_id | string | The alphanumeric string representing the user for this customer contact. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | An alphanumeric string identifying the customer contact. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Customer",
"item": [
{
"name": "List users",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/users",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"users"
]
},
"description": "List all users from a specified customer id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/users",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"users"
]
},
"description": "List all users from a specified customer id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}]"
}
]
},
{
"name": "Get the logged in customer",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/current_customer",
"host": [
"{{fastly_url}}"
],
"path": [
"current_customer"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#get-logged-in-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/current_customer",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"current_customer"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#get-logged-in-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"billing_contact_id\":null,\"billing_network_type\":\"public\",\"billing_ref\":null,\"can_configure_wordpress\":false,\"can_reset_passwords\":true,\"can_upload_vcl\":false,\"force_2fa\":false,\"force_sso\":false,\"has_account_panel\":true,\"has_improved_events\":false,\"has_improved_ssl_config\":false,\"has_openstack_logging\":false,\"has_pci\":false,\"has_pci_passwords\":false,\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"ip_whitelist\":\"0.0.0.0/0\",\"legal_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"name\":\"Test Account\",\"owner_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"phone_number\":\"5555555559\",\"postal_address\":null,\"pricing_plan\":\"developer\",\"pricing_plan_id\":\"6HW4welznAHVnMCJhY9QdX\",\"readonly\":false,\"requires_support_email\":false,\"security_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"technical_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Get a customer",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}"
]
},
"description": "Get a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx"
]
},
"description": "Get a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"billing_contact_id\":null,\"billing_network_type\":\"public\",\"billing_ref\":null,\"can_configure_wordpress\":false,\"can_reset_passwords\":true,\"can_upload_vcl\":false,\"force_2fa\":false,\"force_sso\":false,\"has_account_panel\":true,\"has_improved_events\":false,\"has_improved_ssl_config\":false,\"has_openstack_logging\":false,\"has_pci\":false,\"has_pci_passwords\":false,\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"ip_whitelist\":\"0.0.0.0/0\",\"legal_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"name\":\"Test Account\",\"owner_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"phone_number\":\"5555555559\",\"postal_address\":null,\"pricing_plan\":\"developer\",\"pricing_plan_id\":\"6HW4welznAHVnMCJhY9QdX\",\"readonly\":false,\"requires_support_email\":false,\"security_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"technical_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Update a customer",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#update-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#update-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"billing_contact_id\":null,\"billing_network_type\":\"public\",\"billing_ref\":null,\"can_configure_wordpress\":false,\"can_reset_passwords\":true,\"can_upload_vcl\":false,\"force_2fa\":false,\"force_sso\":false,\"has_account_panel\":true,\"has_improved_events\":false,\"has_improved_ssl_config\":false,\"has_openstack_logging\":false,\"has_pci\":false,\"has_pci_passwords\":false,\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"ip_whitelist\":\"0.0.0.0/0\",\"legal_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"name\":\"Updated Test Account\",\"owner_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"phone_number\":\"5555555559\",\"postal_address\":null,\"pricing_plan\":\"developer\",\"pricing_plan_id\":\"6HW4welznAHVnMCJhY9QdX\",\"readonly\":false,\"requires_support_email\":false,\"security_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"technical_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete a customer",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#delete-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#delete-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "A Customer is the base object that owns your Users and Services. Some information may be limited depending on access level.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| billing_contact_id | string | The alphanumeric string representing the primary billing contact. |\n| billing_network_type | string | Customer's current network revenue type. |\n| billing_ref | string | Used for adding purchased orders to customer's account. |\n| can_configure_wordpress | boolean | Whether this customer can view or edit wordpress. |\n| can_reset_passwords | boolean | Whether this customer can reset passwords. |\n| can_upload_vcl | boolean | Whether this customer can upload VCL. |\n| force_2fa | boolean | Specifies whether 2FA is forced or not forced on the customer account. Logs out non-2FA users once 2FA is force enabled. |\n| force_sso | boolean | Specifies whether SSO is forced or not forced on the customer account. |\n| has_account_panel | boolean | Specifies whether the account has access or does not have access to the account panel. |\n| has_improved_events | boolean | Specifies whether the account has access or does not have access to the improved events. |\n| has_improved_ssl_config | boolean | Whether this customer can view or edit the SSL config. |\n| has_openstack_logging | boolean | Specifies whether the account has enabled or not enabled openstack logging. |\n| has_pci | boolean | Specifies whether the account can edit PCI for a service. |\n| has_pci_passwords | boolean | Specifies whether PCI passwords are required for the account. |\n| ip_whitelist | string | The range of IP addresses authorized to access the customer account. |\n| legal_contact_id | string | The alphanumeric string identifying the account's legal contact. |\n| name | string | The name of the customer, generally the company name. |\n| owner_id | string | The alphanumeric string identifying the account owner. |\n| phone_number | string | The phone number associated with the account. |\n| postal_address | string | The postal address associated with the account. |\n| pricing_plan | string | The pricing plan this customer is under. |\n| pricing_plan_id | string | The alphanumeric string identifying the pricing plan. |\n| security_contact_id | string | The alphanumeric string identifying the account's security contact. |\n| technical_contact_id | string | The alphanumeric string identifying the account's technical contact. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying the customer. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Event logs",
"item": [
{
"name": "List events",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/events?filter[created_at][gt]&filter[created_at][gte]&filter[created_at][lt]&filter[created_at][lte]&filter[created_at]&filter[customer_id]&filter[event_type]&filter[service_id]&filter[token_id]&filter[user_id]&page[number]&page[size]&sort",
"host": [
"{{fastly_url}}"
],
"path": [
"events"
],
"query": [
{
"key": "filter[created_at][gt]",
"description": "Return events after a date and time in ISO 8601 format."
},
{
"key": "filter[created_at][gte]",
"description": "Return events on and after a date and time in ISO 8601 format."
},
{
"key": "filter[created_at][lt]",
"description": "Return events before a date and time in ISO 8601 format."
},
{
"key": "filter[created_at][lte]",
"description": "Return events on and before a date and time in ISO 8601 format."
},
{
"key": "filter[created_at]",
"description": "Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12)."
},
{
"key": "filter[customer_id]",
"description": "Limit the results returned to a specific customer."
},
{
"key": "filter[event_type]",
"description": "Limit the returned events to a specific event_type."
},
{
"key": "filter[service_id]",
"description": "Limit the results returned to a specific service."
},
{
"key": "filter[token_id]",
"description": "Limit the returned events to a specific token."
},
{
"key": "filter[user_id]",
"description": "Limit the results returned to a specific user."
},
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
},
{
"key": "sort",
"description": "The order in which to list the results by creation date."
}
]
},
"description": "List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/events?filter%5Bcustomer_id%5D=x4xCwxxJxGCx123Rx5xTx&page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at?filter[created_at][gt]&filter[created_at][gte]&filter[created_at][lt]&filter[created_at][lte]&filter[created_at]&filter[customer_id]&filter[event_type]&filter[service_id]&filter[token_id]&filter[user_id]&page[number]&page[size]&sort",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"events"
],
"query": [
{
"key": "filter[created_at][gt]",
"description": "Return events after a date and time in ISO 8601 format."
},
{
"key": "filter[created_at][gte]",
"description": "Return events on and after a date and time in ISO 8601 format."
},
{
"key": "filter[created_at][lt]",
"description": "Return events before a date and time in ISO 8601 format."
},
{
"key": "filter[created_at][lte]",
"description": "Return events on and before a date and time in ISO 8601 format."
},
{
"key": "filter[created_at]",
"description": "Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12)."
},
{
"key": "filter[customer_id]",
"description": "Limit the results returned to a specific customer."
},
{
"key": "filter[event_type]",
"description": "Limit the returned events to a specific event_type."
},
{
"key": "filter[service_id]",
"description": "Limit the results returned to a specific service."
},
{
"key": "filter[token_id]",
"description": "Limit the returned events to a specific token."
},
{
"key": "filter[user_id]",
"description": "Limit the results returned to a specific user."
},
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
},
{
"key": "sort",
"description": "The order in which to list the results by creation date."
}
]
},
"description": "List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"attributes\":{\"admin\":false,\"created_at\":\"2016-06-06T20:05:10.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"description\":\"Version 2 was activated\",\"event_type\":\"version.activate\",\"ip\":\"127.0.0.0\",\"metadata\":{\"version_number\":2},\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"user_id\":\"4Pp0BW3UkBEJhG3N0kovLP\",\"token_id\":\"5Yo3XXnrQpjc20u0ybrf2g\"},\"id\":\"5IH1QmNSV1Qi7jXc4oIZlZ\",\"type\":\"event\"}],\"links\":{\"last\":\"http://api.fastly.com/events?filter[customer_id]=x4xCwxxJxGCx123Rx5xTx&page[number]=1&page[size]=1\"}}"
}
]
},
{
"name": "Get an event",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/events/{{event_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"events",
"{{event_id}}"
]
},
"description": "Get a specific event.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/events/1PTzLK8g1NRKMGu5kUb8SC",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"events",
"1PTzLK8g1NRKMGu5kUb8SC"
]
},
"description": "Get a specific event.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"attributes\":{\"admin\":false,\"created_at\":\"2020-06-01T21:29:38.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"description\":\"Version 2 was activated\",\"event_type\":\"version.activate\",\"ip\":\"127.0.0.0\",\"metadata\":{\"version_number\":2},\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"user_id\":\"6MwX4ZZM7Ji4Q3O07dI8Ln\",\"token_id\":\"5Yo3XXnrQpjc20u0ybrf2g\"},\"id\":\"1PTzLK8g1NRKMGu5kUb8SC\",\"type\":\"event\"}}"
}
]
}
],
"description": "Event logs are used to audit actions performed by customers.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| admin | boolean | Indicates if event was performed by Fastly. |\n| created_at | string | Date and time in ISO 8601 format. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| description | string | Description of the event. |\n| event_type | string | Type of event. Can be used with filter[event_type]. |\n| | api_key.create | An API key was created. |\n| | acl.create | An access control list was created. |\n| | acl.delete | An access control list was deleted. |\n| | acl.update | An access control list was updated. |\n| | address.create | A customer billing address was created. |\n| | address.delete | A customer billing address was deleted. |\n| | address.update | A customer billing address was updated. |\n| | alerts.definition.create | A customer alert definition was created. |\n| | alerts.definition.delete | A customer alert definition was deleted. |\n| | alerts.definition.test | A customer alert definition was tested. |\n| | alerts.definition.update | A customer alert definition was updated. |\n| | backend.create | A backend was added to a service. |\n| | backend.delete | A backend was removed from a service. |\n| | backend.update | A backend was updated. |\n| | billing.contact_update | A billing contact was updated. |\n| | cache_settings.create | A cache settings configuration object was created. |\n| | cache_settings.delete | A cache settings configuration object was deleted. |\n| | cache_settings.update | A cache settings configuration object was updated. |\n| | customer.create | A customer was created. |\n| | customer.pricing | A customer pricing plan was changed. |\n| | customer.update | A customer was updated. |\n| | customer_feature.create | A feature flag was applied to the customer account. |\n| | customer_feature.delete | A feature flag was removed from the customer account. |\n| | director.create | A load-balancing director was created. |\n| | director.delete | A load-balancing director was deleted. |\n| | director.update | A load-balancing director was updated. |\n| | director_backend.create | A backend was assigned to a load-balancing director. |\n| | director_backend.delete | A backend was removed from a load-balancing director. |\n| | domain.create | A domain was assigned to a service. |\n| | domain.delete | A domain was removed from a service. |\n| | domain.update | A domain was updated. |\n| | gzip.create | A gzip policy was created. |\n| | gzip.delete | A gzip policy was deleted. |\n| | gzip.update | A gzip policy was updated. |\n| | header.create | A header configuration object was created. |\n| | header.delete | A header configuration object was deleted. |\n| | header.update | A header configuration object was updated. |\n| | healthcheck.create | A healthcheck was created. |\n| | healthcheck.delete | A healthcheck was deleted. |\n| | healthcheck.update | A healthcheck was updated. |\n| | invitation.accept | An account invitation was accepted. |\n| | invitation.sent | An account invitation was sent. |\n| | invoice.failed_payment | An invoice payment failed. |\n| | invoice.payment | An invoice was paid. |\n| | io_settings.create | Image optimization was activated. |\n| | io_settings.delete | Image optimization was deactivated. |\n| | io_settings.update | Image optimization was updated. |\n| | logging.create | A log endpoint was created. |\n| | logging.delete | A log endpoint was deleted. |\n| | logging.update | A log endpoint was updated. |\n| | pool.create | A dynamic server pool was created. |\n| | pool.delete | A dynamic server pool was deleted. |\n| | pool.update | A dynamic server pool was updated. |\n| | request_settings.create | A request settings configuration object was created. |\n| | request_settings.delete | A request settings configuration object was deleted. |\n| | request_settings.update | A request settings configuration object was updated. |\n| | response_object.create | A response object was created. |\n| | response_object.delete | A response object was deleted. |\n| | response_object.update | A response object was updated. |\n| | rule_status.update | A WAF rule status was updated. |\n| | rule_status.upsert | A WAF rule status was upserted. |\n| | security.workspace.create | A security workspace was created. |\n| | security.workspace.update | A security workspace was updated. |\n| | security.workspace.delete | A security workspace was deleted. |\n| | security.redaction.create | A security redaction was created. |\n| | security.redaction.update | A security redaction was updated. |\n| | security.redaction.delete | A security redaction was deleted. |\n| | security.rule.create | A security rule was created. |\n| | security.rule.update | A security rule was updated. |\n| | security.rule.delete | A security rule was deleted. |\n| | security.virtual_patch.create | A security virtual patch was created. |\n| | security.virtual_patch.update | A security virtual patch was updated. |\n| | security.virtual_patch.delete | A security virtual patch was deleted. |\n| | security.event.update | A security event was updated. |\n| | server.create | A server was created as part of a dynamic server pool. |\n| | server.delete | A server was deleted as part of a dynamic server pool. |\n| | server.update | A server was updated as part of a dynamic server pool. |\n| | service.create | A service was created. |\n| | service.delete | A service was deleted. |\n| | service.move | A service was moved to another customer. |\n| | service.move_destination | A service was moved from another customer. |\n| | service.move_source | A service was moved to another customer. |\n| | service.purge_all | The cache was purged for a service. |\n| | service.update | A service was updated. |\n| | service_authorization.create | A service authorization was created. |\n| | service_authorization.delete | A service authorization was deleted. |\n| | service_authorization.update | A service authorization was updated. |\n| | tls.bulk_certificate.create | A bulk TLS certificate was created. |\n| | tls.bulk_certificate.delete | A bulk TLS certificate was deleted. |\n| | tls.bulk_certificate.update | A bulk TLS certificate was updated. |\n| | tls.certificate.create | A TLS certificate was created. |\n| | tls.certificate.expiration_email | Certificate expiration email was sent. |\n| | tls.certificate.update | A TLS certificate was updated. |\n| | tls.certificate.delete | A TLS certificate was deleted. |\n| | tls.configuration.update | TLS configuration was updated. |\n| | tls.private_key.create | A private key was created. |\n| | tls.private_key.delete | A private key was deleted. |\n| | tls.activation.enable | TLS activation was enabled. |\n| | tls.activation.update | TLS activation was updated. |\n| | tls.activation.disable | TLS activation was disabled. |\n| | tls.globalsign.domain.create | A GlobalSign SAN entry was added. |\n| | tls.globalsign.domain.verify | GlobalSign SAN entry verification was requested. |\n| | tls.globalsign.domain.delete | A GlobalSign SAN entry was deleted. |\n| | tls.subscription.create | A TLS subscription was created. |\n| | tls.subscription.delete | A TLS subscription was deleted. |\n| | tls.subscription.dns_check_email | A TLS subscription renewal DNS check email was sent. |\n| | token.create | An API token was created or a user logged into the web interface. |\n| | token.destroy | An API token was revoked. |\n| | two_factor_auth.disable | Two-factor authentication was disabled. |\n| | two_factor_auth.enable | Two-factor authentication was enabled. |\n| | user.create | A user account was created. |\n| | user.destroy | A user account was deleted. |\n| | user.lock | A user account was locked. |\n| | user.login | Deprecated. See token.create. |\n| | user.login_failure | A user account login attempt failed. |\n| | user.logout | Deprecated. See token.destroy. |\n| | user.password_update | An account password was updated. |\n| | user.unlock | A user account was unlocked. |\n| | user.update | A user account was updated. |\n| | vcl.create | A custom VCL file was created. |\n| | vcl.delete | A custom VCL file was deleted. |\n| | vcl.update | A custom VCL file was updated. |\n| | version.activate | A service version was activated. |\n| | version.clone | A service version was cloned. |\n| | version.copy | A service version was copied to another service. |\n| | version.copy_destination | The service version was copied from another service. |\n| | version.copy_source | The service version was copied to another service. |\n| | version.create | A service version was created. |\n| | version.deactivate | A service version was deactivated. |\n| | version.lock | A service version was locked. |\n| | version.update | A service version was updated. |\n| | waf.configuration_set_update | A WAF configuration set was updated. |\n| | waf.create | A WAF object was created. |\n| | waf.delete | A WAF object was deleted. |\n| | waf.update | A WAF object was updated. |\n| | waf.enable | A WAF object was enabled. |\n| | waf.disable | A WAF object was disabled. |\n| | waf.owasp.create | A WAF OWASP setting was created. |\n| | waf.owasp.update | A WAF OWASP setting was updated. |\n| | waf.ruleset.deploy | A WAF ruleset was deployed. |\n| | waf.ruleset.deploy_failure | A WAF ruleset's deployment failed. |\n| | wordpress.create | A WordPress rule was created. |\n| | wordpress.delete | A WordPress rule was deleted. |\n| | wordpress.update | A WordPress rule was updated. |\n| id | string | Alphanumeric string identifying an event. |\n| ip | string | IP addresses that the event was requested from. |\n| metadata | object | Hash of key value pairs of additional information. |\n| service_id | string | Alphanumeric string identifying the service. |\n| token_id | string | Alphanumeric string identifying a token. |\n| type | string | Resource type. |\n| | event | The event type. |\n| user_id | string | Alphanumeric string identifying the user. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Invitations",
"item": [
{
"name": "List invitations",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/invitations?page[number]&page[size]",
"host": [
"{{fastly_url}}"
],
"path": [
"invitations"
],
"query": [
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
}
]
},
"description": "List all invitations.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/invitations?page%5Bnumber%5D=1&page%5Bsize%5D=20?page[number]&page[size]",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"invitations"
],
"query": [
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
}
]
},
"description": "List all invitations.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"invitation\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null,\"email\":\"john@example.com\",\"role\":\"superuser\",\"status_code\":1,\"updated_at\":\"2020-03-15T20:10:09.000Z\"},\"relationships\":{\"customer\":{\"data\":{\"type\":\"customer\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}],\"links\":{\"last\":\"http://api.fastly.com/invitations?page[number]=1&page[size]=100\"},\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1}}"
}
]
},
{
"name": "Create an invitation",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"invitation\",\"attributes\":{\"email\":\"thelma@example.com\",\"limit_services\":true,\"role\":\"engineer\"},\"relationships\":{\"customer\":{\"data\":{\"id\":\"44tb1D3asjhhuh2SH8e8YD\",\"type\":\"customer\"}},\"service_invitations\":{\"data\":[{\"type\":\"service_invitation\",\"attributes\":{\"permission\":\"purge_all\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"6yrrdleXQ9QDtum9rMB0nr\"}}}}]}}}}"
},
"url": {
"raw": "{{fastly_url}}/invitations",
"host": [
"{{fastly_url}}"
],
"path": [
"invitations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#create-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"invitation\",\"attributes\":{\"email\":\"thelma@example.com\",\"limit_services\":true,\"role\":\"engineer\"},\"relationships\":{\"customer\":{\"data\":{\"id\":\"44tb1D3asjhhuh2SH8e8YD\",\"type\":\"customer\"}},\"service_invitations\":{\"data\":[{\"type\":\"service_invitation\",\"attributes\":{\"permission\":\"purge_all\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"6yrrdleXQ9QDtum9rMB0nr\"}}}}]}}}}"
},
"url": {
"raw": "https://api.fastly.com/invitations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"invitations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#create-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"7kP8T3JrqSD2ZdijWGxOB1\",\"type\":\"invitation\",\"attributes\":{\"created_at\":\"2020-05-09T18:45:17.000Z\",\"email\":\"thelma@example.com\",\"deleted_at\":null,\"role\":\"user\",\"status_code\":1,\"updated_at\":\"2020-05-09T18:45:17.000Z\",\"limit_services\":true},\"relationships\":{\"customer\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"customer\"}},\"service_invitations\":{\"data\":[{\"id\":\"QNcWQmR5UIpVVO6f1Y3Rl\",\"type\":\"service_invitation\"}]}}},\"included\":[{\"id\":\"QNcWQmR5UIpVVO6f1Y3Rl\",\"type\":\"service_invitation\",\"attributes\":{\"permission\":\"purge_all\",\"created_at\":\"2020-05-09T18:45:18.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-05-09T18:45:18.000Z\"}},{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"customer\",\"attributes\":{\"created_at\":\"2020-05-09T18:45:17.000Z\",\"deleted_at\":null,\"name\":\"Test\",\"phone_number\":\"875.788.2000 x29959\",\"postal_address\":null,\"updated_at\":\"2020-05-09T18:45:17.000Z\"}}]}"
}
]
},
{
"name": "Delete an invitation",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/invitations/{{invitation_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"invitations",
"{{invitation_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#delete-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/invitations/3krg2uUGZzb2W9Euo4moOY",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"invitations",
"3krg2uUGZzb2W9Euo4moOY"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#delete-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
}
],
"description": "Invitations allow superusers and engineers to invite users to set up accounts as collaborators under a main customer account. Superusers can invite collaborators and assign them any role or permission level on a per-service basis. Engineers with no per-service limitations on their role can only invite new collaborators but cannot modify their permissions.\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| email | string | The email address of the invitee. |\n| limit_services | boolean | Indicates the user has limited access to the customer's services. |\n| role | string | The permissions role assigned to the user. Can be user, billing, engineer, or superuser. |\n| status_code | integer | Indicates whether or not the invitation is active. |\n| | 0 | Inactive. |\n| | 1 | Active. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying an invitation. |\n| relationships.customer.id | string | Alphanumeric string identifying the customer. |\n| updated_at | string | Date and time in ISO 8601 format. |"
},
{
"name": "Invoices API",
"item": [
{
"name": "List of invoices",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/billing/v3/invoices?billing_end_date&billing_start_date&cursor&limit",
"host": [
"{{fastly_url}}"
],
"path": [
"billing",
"v3",
"invoices"
],
"query": [
{
"key": "billing_end_date",
"description": "Filter invoices by billing end date."
},
{
"key": "billing_start_date",
"description": "Filter invoices by billing start date."
},
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 200."
}
]
},
"description": "Returns the list of invoices, sorted by billing start date (newest to oldest).\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/billing/v3/invoices?billing_end_date=2023-01-31&billing_start_date=2023-01-01?billing_end_date&billing_start_date&cursor&limit",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"billing",
"v3",
"invoices"
],
"query": [
{
"key": "billing_end_date",
"description": "Filter invoices by billing end date."
},
{
"key": "billing_start_date",
"description": "Filter invoices by billing start date."
},
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 200."
}
]
},
"description": "Returns the list of invoices, sorted by billing start date (newest to oldest).\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"customer_id\":\"2sLme2UJR3SksnvKdEXHri\",\"invoice_id\":\"39973421\",\"invoice_posted_on\":\"2020-07-01T08:44:24Z\",\"billing_start_date\":\"2020-06-01T00:00:00Z\",\"billing_end_date\":\"2020-06-30T00:00:00Z\",\"statement_number\":\"295826163\",\"currency_code\":\"USD\",\"monthly_transaction_amount\":0,\"payment_status\":\"paid\",\"transaction_line_items\":[{\"description\":\"Monthly Minimum Fee\",\"amount\":50,\"credit_coupon_code\":\"\",\"rate\":50,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"},{\"description\":\"Developer Account\",\"amount\":-50,\"credit_coupon_code\":\"developer\",\"rate\":-50,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"}]},{\"customer_id\":\"2sLme2UJR3SksnvKdEXHri\",\"invoice_id\":\"39472869\",\"invoice_posted_on\":\"2020-06-01T10:43:06Z\",\"billing_start_date\":\"2020-05-01T00:00:00Z\",\"billing_end_date\":\"2020-05-31T00:00:00Z\",\"statement_number\":\"291985823\",\"currency_code\":\"USD\",\"monthly_transaction_amount\":0,\"payment_status\":\"paid\",\"transaction_line_items\":[{\"description\":\"Monthly Minimum Fee\",\"amount\":50,\"credit_coupon_code\":\"\",\"rate\":50,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"},{\"description\":\"Developer Account\",\"amount\":-50,\"credit_coupon_code\":\"developer\",\"rate\":-50,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"}]}],\"meta\":{\"next_cursor\":\"\",\"limit\":2,\"total\":2,\"sort\":\"-billing_start_date\"}}"
}
]
},
{
"name": "Get invoice by ID",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/billing/v3/invoices/{{invoice_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"billing",
"v3",
"invoices",
"{{invoice_id}}"
]
},
"description": "Returns invoice associated with the invoice id.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/billing/v3/invoices/4183280",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"billing",
"v3",
"invoices",
"4183280"
]
},
"description": "Returns invoice associated with the invoice id.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"customer_id\":\"2sLme2UJR3SksnvKdEXHri\",\"invoice_id\":\"39973421\",\"invoice_posted_on\":\"2020-07-01T08:44:24Z\",\"billing_start_date\":\"2020-06-01T00:00:00Z\",\"billing_end_date\":\"2020-06-30T00:00:00Z\",\"statement_number\":\"295826163\",\"currency_code\":\"USD\",\"monthly_transaction_amount\":0,\"payment_status\":\"paid\",\"transaction_line_items\":[{\"description\":\"Monthly Minimum Fee\",\"amount\":50,\"credit_coupon_code\":\"\",\"rate\":50,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"},{\"description\":\"Developer Account\",\"amount\":-50,\"credit_coupon_code\":\"developer\",\"rate\":-50,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"}]}"
}
]
},
{
"name": "Get month-to-date invoice",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/billing/v3/invoices/month-to-date",
"host": [
"{{fastly_url}}"
],
"path": [
"billing",
"v3",
"invoices",
"month-to-date"
]
},
"description": "Returns month-to-date invoice for the current month.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/billing/v3/invoices/month-to-date",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"billing",
"v3",
"invoices",
"month-to-date"
]
},
"description": "Returns month-to-date invoice for the current month.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"invoice_id\":\"XO1DhSTCeOr8HKCAC7cycg\",\"customer_id\":\"2sLme2UJR3SksnvKdEXHri\",\"billing_start_date\":\"2020-07-01T00:00:00Z\",\"billing_end_date\":\"2020-07-26T17:30:05Z\",\"monthly_transaction_amount\":\"0.00\",\"transaction_line_items\":[{\"description\":\"Developer Account\",\"amount\":-50,\"rate\":0,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"},{\"description\":\"Monthly Minimum Fee\",\"amount\":50,\"rate\":0,\"units\":1,\"product_name\":\"Committed Amount\",\"product_group\":\"Full Site Delivery\",\"product_line\":\"Network Services\",\"region\":\"Global\",\"usage_type\":\"Committed Amount\"}]}"
}
]
}
],
"description": "Get information on current and past invoices.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| billing_end_date | string | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. |\n| billing_start_date | string | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. |\n| currency_code | string | Three-letter code representing a specific currency used for financial transactions. |\n| customer_id | string | Customer ID associated with the invoice. |\n| invoice_id | string | Numeric string identifying the invoice. |\n| invoice_posted_on | string | Date and time invoice was posted on, in ISO 8601 format. |\n| monthly_transaction_amount | number | Total billable amount for invoiced services charged within a single month. |\n| statement_number | string | Alphanumeric string identifying the statement number. |\n| amount | number | Billed amount for line item. |\n| credit_coupon_code | string | Discount coupon associated with the invoice for any account or service credits. |\n| description | string | Invoice line item transaction name. |\n| product_group | string | The broader classification of the product (e.g., Compute or Full-Site Delivery). |\n| product_line | string | The broader classification of the product (e.g., Network Services or Security). |\n| product_name | string | The name of the product. |\n| rate | number | Price per unit. |\n| region | string | The geographical area applicable for regionally based products. |\n| units | number | Total number of units of usage. |\n| usage_type | string | The unit of measure (e.g., requests or bandwidth). |\n| meta | object | Pagination metadata. |\n| limit | integer | The number of invoices included in the response. |\n| next_cursor | string | The token used to request the next set of results. |\n| sort | string | The sort order of the invoices in the response. |\n| total | integer | Total number of records available on the backend. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Service authorizations",
"item": [
{
"name": "Show service authorization",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/service-authorizations/{{service_authorization_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations",
"{{service_authorization_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#show-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/service-authorizations/3krg2uUGZzb2W9Euo4moOY",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations",
"3krg2uUGZzb2W9Euo4moOY"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#show-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}}}}}"
}
]
},
{
"name": "Delete service authorization",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/service-authorizations/{{service_authorization_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations",
"{{service_authorization_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/service-authorizations/3krg2uUGZzb2W9Euo4moOY",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations",
"3krg2uUGZzb2W9Euo4moOY"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Update service authorization",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}}}"
},
"url": {
"raw": "{{fastly_url}}/service-authorizations/{{service_authorization_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations",
"{{service_authorization_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}}}"
},
"url": {
"raw": "https://api.fastly.com/service-authorizations/3krg2uUGZzb2W9Euo4moOY",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations",
"3krg2uUGZzb2W9Euo4moOY"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"}}}"
}
]
},
{
"name": "List service authorizations",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/service-authorizations?page[number]&page[size]",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations"
],
"query": [
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
}
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#list-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/service-authorizations?page%5Bnumber%5D=1&page%5Bsize%5D=20?page[number]&page[size]",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations"
],
"query": [
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
}
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#list-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}}}}],\"links\":{\"last\":\"http://api.fastly.com/service-authorizations?page[number]=1&page[size]=100\"},\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1}}"
}
]
},
{
"name": "Create service authorization",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"
},
"url": {
"raw": "{{fastly_url}}/service-authorizations",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#create-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"
},
"url": {
"raw": "https://api.fastly.com/service-authorizations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#create-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"
}
]
},
{
"name": "Delete service authorizations",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json; ext=bulk"
},
{
"key": "Accept",
"value": "application/vnd.api+json; ext=bulk"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\"}]}"
},
"url": {
"raw": "{{fastly_url}}/service-authorizations",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json; ext=bulk"
},
{
"key": "Accept",
"value": "application/vnd.api+json; ext=bulk"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\"}]}"
},
"url": {
"raw": "https://api.fastly.com/service-authorizations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":\"2020-03-16T20:07:34.000Z\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":\"2020-03-16T20:07:34.000Z\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"hTE5dRlSBICGPJxJwCH4M\"}}}}]}"
}
]
},
{
"name": "Update service authorizations",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json; ext=bulk"
},
{
"key": "Accept",
"value": "application/vnd.api+json; ext=bulk"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"purge_all\"}}]}"
},
"url": {
"raw": "{{fastly_url}}/service-authorizations",
"host": [
"{{fastly_url}}"
],
"path": [
"service-authorizations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json; ext=bulk"
},
{
"key": "Accept",
"value": "application/vnd.api+json; ext=bulk"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"purge_all\"}}]}"
},
"url": {
"raw": "https://api.fastly.com/service-authorizations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service-authorizations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"purge_all\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"hTE5dRlSBICGPJxJwCH4M\"}}}}]}"
}
]
}
],
"description": "A service authorization allows limited users to access only specified services.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| permission | string | The permission the user has in relation to the service. |\n| relationships.service.id | string | Alphanumeric string identifying the service. |\n| relationships.user.id | string | The ID of the user being given access to the service. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a service authorization. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Star",
"item": [
{
"name": "Get a star",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/stars/{{star_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"stars",
"{{star_id}}"
]
},
"description": "Show star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/stars/3krg2uUGZzb2W9Euo4moOY",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stars",
"3krg2uUGZzb2W9Euo4moOY"
]
},
"description": "Show star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"star\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\"}}}}}"
}
]
},
{
"name": "Delete a star",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/stars/{{star_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"stars",
"{{star_id}}"
]
},
"description": "Delete star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/stars/3krg2uUGZzb2W9Euo4moOY",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stars",
"3krg2uUGZzb2W9Euo4moOY"
]
},
"description": "Delete star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "List stars",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/stars",
"host": [
"{{fastly_url}}"
],
"path": [
"stars"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/star/#list-service-stars)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/stars",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stars"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/star/#list-service-stars)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"type\":\"star\",\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":[{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}}}],\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1},\"links\":{\"last\":\"http://api.fastly.com/stars?page[number]=1&page[size]=100\"}}"
}
]
},
{
"name": "Create a star",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"star\",\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"
},
"url": {
"raw": "{{fastly_url}}/stars",
"host": [
"{{fastly_url}}"
],
"path": [
"stars"
]
},
"description": "Create star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"star\",\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"
},
"url": {
"raw": "https://api.fastly.com/stars",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stars"
]
},
"description": "Create star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"star\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\"}}}}}"
}
]
}
],
"description": "A star allows users to mark services of interest.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| relationships.service.id | string | Alphanumeric string identifying the service. |\n| relationships.user.id | string | Alphanumeric string identifying the user. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a star. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "User",
"item": [
{
"name": "Get the current user",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/current_user",
"host": [
"{{fastly_url}}"
],
"path": [
"current_user"
]
},
"description": "Get the logged in user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/current_user",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"current_user"
]
},
"description": "Get the logged in user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}"
}
]
},
{
"name": "Get a user",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/user/{{user_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"user",
"{{user_id}}"
]
},
"description": "Get a specific user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/user/x9KzsrACXZv8tPwlEDsKb6",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"user",
"x9KzsrACXZv8tPwlEDsKb6"
]
},
"description": "Get a specific user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}"
}
]
},
{
"name": "Update a user",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/user/{{user_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"user",
"{{user_id}}"
]
},
"description": "Update a user. Only users with the role of superuser can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Two-factor attributes are not editable via this endpoint.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/user/x9KzsrACXZv8tPwlEDsKb6",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"user",
"x9KzsrACXZv8tPwlEDsKb6"
]
},
"description": "Update a user. Only users with the role of superuser can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Two-factor attributes are not editable via this endpoint.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Updated Name\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}"
}
]
},
{
"name": "Delete a user",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/user/{{user_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"user",
"{{user_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#delete-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/user/x9KzsrACXZv8tPwlEDsKb6",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"user",
"x9KzsrACXZv8tPwlEDsKb6"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#delete-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
},
{
"name": "Create a user",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/user",
"host": [
"{{fastly_url}}"
],
"path": [
"user"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#create-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/user",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"user"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#create-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}"
}
]
},
{
"name": "Update the user's password",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/current_user/password",
"host": [
"{{fastly_url}}"
],
"path": [
"current_user",
"password"
]
},
"description": "Update the user's password to a new one.\n> **Authorization**: Username and password.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/current_user/password",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"current_user",
"password"
]
},
"description": "Update the user's password to a new one.\n> **Authorization**: Username and password.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}"
}
]
},
{
"name": "Request a password reset",
"request": {
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/user/{{user_login}}/password/request_reset",
"host": [
"{{fastly_url}}"
],
"path": [
"user",
"{{user_login}}",
"password",
"request_reset"
]
},
"description": "Requests a password reset for the specified user."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/user/krisowner@example.com/password/request_reset",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"user",
"krisowner@example.com",
"password",
"request_reset"
]
},
"description": "Requests a password reset for the specified user."
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "A user of the Fastly API and web interface. A user is always associated with a customer. Some information may be limited depending on access level.\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| new_password | string | The user's new password. |\n| old_password | string | The user's current password. |\n| limit_services | boolean | Indicates that the user has limited access to the customer's services. |\n| locked | boolean | Indicates whether the is account is locked for editing or not. |\n| login | string | The login associated with the user (typically, an email address). |\n| name | string | The real life name of the user. |\n| require_new_password | boolean | Indicates if a new password is required at next login. |\n| role | string | The permissions role assigned to the user. Can be user, billing, engineer, or superuser. |\n| two_factor_auth_enabled | boolean | Indicates if 2FA is enabled on the user. |\n| two_factor_setup_required | boolean | Indicates if 2FA is required by the user's customer account. |\n| created_at | string | Date and time in ISO 8601 format. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| email_hash | string | The alphanumeric string identifying a email login. |\n| id | string | Alphanumeric string identifying the user. |\n| updated_at | string | Date and time in ISO 8601 format. |"
}
]
},
{
"name": "Access control lists",
"item": [
{
"name": "ACL Entry",
"item": [
{
"name": "List ACL entries",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entries?direction&page&per_page&sort",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"acl",
"{{acl_id}}",
"entries"
],
"query": [
{
"key": "direction",
"description": "Direction in which to sort results."
},
{
"key": "page",
"description": "Current page."
},
{
"key": "per_page",
"description": "Number of records per page."
},
{
"key": "sort",
"description": "Field on which to sort."
}
]
},
"description": "List ACL entries for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entries?direction=ascend&page=1&per_page=20&sort=created?direction&page&per_page&sort",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"acl",
"6tUXdegLTf5BCig0zGFrU3",
"entries"
],
"query": [
{
"key": "direction",
"description": "Direction in which to sort results."
},
{
"key": "page",
"description": "Current page."
},
{
"key": "per_page",
"description": "Number of records per page."
},
{
"key": "sort",
"description": "Field on which to sort."
}
]
},
"description": "List ACL entries for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"192.168.0.1\",\"negated\":0,\"subnet\":16,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Update multiple ACL entries",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"entries\":[{\"op\":\"create\",\"ip\":\"192.168.0.1\",\"subnet\":8},{\"op\":\"update\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"ip\":\"192.168.0.2\",\"subnet\":16},{\"op\":\"delete\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\"}]}"
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entries",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"acl",
"{{acl_id}}",
"entries"
]
},
"description": "Update multiple ACL entries on the same ACL. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 entries. Contact support to discuss raising this limit.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"entries\":[{\"op\":\"create\",\"ip\":\"192.168.0.1\",\"subnet\":8},{\"op\":\"update\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"ip\":\"192.168.0.2\",\"subnet\":16},{\"op\":\"delete\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\"}]}"
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entries",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"acl",
"6tUXdegLTf5BCig0zGFrU3",
"entries"
]
},
"description": "Update multiple ACL entries on the same ACL. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 entries. Contact support to discuss raising this limit.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
},
{
"name": "Describe an ACL entry",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry/{{acl_entry_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"acl",
"{{acl_id}}",
"entry",
"{{acl_entry_id}}"
]
},
"description": "Retrieve a single ACL entry.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry/6yxNzlOpW1V7JfSwvLGtOc",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"acl",
"6tUXdegLTf5BCig0zGFrU3",
"entry",
"6yxNzlOpW1V7JfSwvLGtOc"
]
},
"description": "Retrieve a single ACL entry.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"192.168.0.1\",\"negated\":0,\"subnet\":16,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete an ACL entry",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry/{{acl_entry_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"acl",
"{{acl_id}}",
"entry",
"{{acl_entry_id}}"
]
},
"description": "Delete an ACL entry from a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry/6yxNzlOpW1V7JfSwvLGtOc",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"acl",
"6tUXdegLTf5BCig0zGFrU3",
"entry",
"6yxNzlOpW1V7JfSwvLGtOc"
]
},
"description": "Delete an ACL entry from a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
},
{
"name": "Update an ACL entry",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"subnet\":8}"
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry/{{acl_entry_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"acl",
"{{acl_id}}",
"entry",
"{{acl_entry_id}}"
]
},
"description": "Update an ACL entry for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"subnet\":8}"
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry/6yxNzlOpW1V7JfSwvLGtOc",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"acl",
"6tUXdegLTf5BCig0zGFrU3",
"entry",
"6yxNzlOpW1V7JfSwvLGtOc"
]
},
"description": "Update an ACL entry for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"192.168.0.1\",\"negated\":0,\"subnet\":8,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Create an ACL entry",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"subnet\":16,\"ip\":\"192.168.0.1\"}"
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"acl",
"{{acl_id}}",
"entry"
]
},
"description": "Add an ACL entry to an ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"subnet\":16,\"ip\":\"192.168.0.1\"}"
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"acl",
"6tUXdegLTf5BCig0zGFrU3",
"entry"
]
},
"description": "Add an ACL entry to an ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"192.168.0.1\",\"negated\":0,\"subnet\":16,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}"
}
]
}
],
"description": "An ACL entry holds an individual IP address or subnet range and is a member of an ACL. ACL entries are versionless, which means they can be created, modified, or deleted without activating a new version of your service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| comment | string | A freeform descriptive note. |\n| ip | string | An IP address. |\n| negated | integer | Whether to negate the match. Useful primarily when creating individual exceptions to larger subnets. |\n| | 0 | disable negation. |\n| | 1 | enable negation. |\n| subnet | integer | Number of bits for the subnet mask applied to the IP address. For IPv4 addresses, a value of 32 represents the smallest subnet mask (1 address), 24 represents a class C subnet mask (256 addresses), 16 represents a class B subnet mask (65k addresses), and 8 is class A subnet mask (16m addresses). If not provided, no mask is applied. |\n| acl_id | string | Alphanumeric string identifying a ACL. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying an ACL Entry. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "ACL",
"item": [
{
"name": "List ACLs",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"acl"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acl/#list-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"acl"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acl/#list-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"version\":\"1\",\"name\":\"test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}]"
}
]
},
{
"name": "Create a new ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"acl"
]
},
"description": "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.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"acl"
]
},
"description": "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.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"version\":\"1\",\"name\":\"test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
},
{
"name": "Describe an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl/{{acl_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"acl",
"{{acl_name}}"
]
},
"description": "Retrieve a single ACL by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl/test-acl",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"acl",
"test-acl"
]
},
"description": "Retrieve a single ACL by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"version\":\"1\",\"name\":\"test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
},
{
"name": "Update an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl/{{acl_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"acl",
"{{acl_name}}"
]
},
"description": "Update an ACL for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl/test-acl",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"acl",
"test-acl"
]
},
"description": "Update an ACL for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"version\":\"1\",\"name\":\"updated-test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
},
{
"name": "Delete an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl/{{acl_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"acl",
"{{acl_name}}"
]
},
"description": "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.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl/test-acl",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"acl",
"test-acl"
]
},
"description": "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.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "An access control list or \"ACL\" specifies individual IP addresses or subnet ranges and can be accessed and used from Fastly VCL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a ACL. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String representing the number identifying a version of the service. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "ACLs in Compute",
"item": [
{
"name": "List ACLs",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/resources/acls",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls"
]
},
"description": "List all ACLs.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/resources/acls",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls"
]
},
"description": "List all ACLs.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"name\":\"my-test-acl\",\"id\":\"ipyym7sp3s4w49po05p1ir\"},{\"name\":\"my-other-acl\",\"id\":\"piyy7mpss34w49po501pri\"}],\"meta\":{\"total\":2}}"
}
]
},
{
"name": "Create a new ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"my-test-acl\"}"
},
"url": {
"raw": "{{fastly_url}}/resources/acls",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-create-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"my-test-acl\"}"
},
"url": {
"raw": "https://api.fastly.com/resources/acls",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-create-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"my-test-acl\",\"id\":\"ipyym7sp3s4w49po05p1ir\"}"
}
]
},
{
"name": "Describe an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/resources/acls/{{acl_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls",
"{{acl_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-list-acls-s-acl_id)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/resources/acls/{{acl_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls",
"{{acl_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-list-acls-s-acl_id)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"my-test-acl\",\"id\":\"ipyym7sp3s4w49po05p1ir\"}"
}
]
},
{
"name": "Delete an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/resources/acls/{{acl_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls",
"{{acl_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-delete-s-acl_id)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/resources/acls/{{acl_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls",
"{{acl_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-delete-s-acl_id)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Lookup an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/resources/acls/{{acl_id}}/entry/{{acl_ip}}",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls",
"{{acl_id}}",
"entry",
"{{acl_ip}}"
]
},
"description": "Find a matching ACL entry for an IP address.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/resources/acls/{{acl_id}}/entry/{{acl_ip}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls",
"{{acl_id}}",
"entry",
"{{acl_ip}}"
]
},
"description": "Find a matching ACL entry for an IP address.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"prefix\":\"192.0.2.0/24\",\"action\":\"block\"}"
}
]
},
{
"name": "List an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/resources/acls/{{acl_id}}/entries?cursor&limit",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls",
"{{acl_id}}",
"entries"
],
"query": [
{
"key": "cursor",
"description": "Use to paginate through results."
},
{
"key": "limit",
"description": "The maximum number of items included in the response."
}
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-list-acl-entries)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/resources/acls/{{acl_id}}/entries?cursor&limit",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls",
"{{acl_id}}",
"entries"
],
"query": [
{
"key": "cursor",
"description": "Use to paginate through results."
},
{
"key": "limit",
"description": "The maximum number of items included in the response."
}
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-list-acl-entries)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"entries\":[{\"prefix\":\"1.2.3.0/24\",\"action\":\"BLOCK\"},{\"prefix\":\"192.168.0.0/16\",\"action\":\"BLOCK\"},{\"prefix\":\"23.23.23.23/32\",\"action\":\"ALLOW\"},{\"prefix\":\"1.2.3.4/32\",\"action\":\"ALLOW\"}],\"meta\":{\"limit\":100,\"next_cursor\":\"next-cursor-id\"}}"
}
]
},
{
"name": "Update an ACL",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"entries\":[{\"op\":\"create\",\"prefix\":\"1.2.3.0/24\",\"action\":\"BLOCK\"},{\"op\":\"update\",\"prefix\":\"192.168.0.0/16\",\"action\":\"BLOCK\"},{\"op\":\"create\",\"prefix\":\"23.23.23.23/32\",\"action\":\"ALLOW\"},{\"op\":\"update\",\"prefix\":\"1.2.3.4/32\",\"action\":\"ALLOW\"}]}"
},
"url": {
"raw": "{{fastly_url}}/resources/acls/{{acl_id}}/entries",
"host": [
"{{fastly_url}}"
],
"path": [
"resources",
"acls",
"{{acl_id}}",
"entries"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-update-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"entries\":[{\"op\":\"create\",\"prefix\":\"1.2.3.0/24\",\"action\":\"BLOCK\"},{\"op\":\"update\",\"prefix\":\"192.168.0.0/16\",\"action\":\"BLOCK\"},{\"op\":\"create\",\"prefix\":\"23.23.23.23/32\",\"action\":\"ALLOW\"},{\"op\":\"update\",\"prefix\":\"1.2.3.4/32\",\"action\":\"ALLOW\"}]}"
},
"url": {
"raw": "https://api.fastly.com/resources/acls/{{acl_id}}/entries",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"resources",
"acls",
"{{acl_id}}",
"entries"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acls/#compute-acl-update-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
}
],
"description": "An access control list (ACL) specifies individual IP addresses or subnet ranges and can be accessed and used from the Fastly Compute platform.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Human readable name of store. |\n| id | string | An example identifier (UUID). |\n| action | string | One of \"ALLOW\" or \"BLOCK\". |\n| prefix | string | An IP prefix defined in Classless Inter-Domain Routing (CIDR) format, i.e. a valid IP address (v4 or v6) followed by a forward slash (/) and a prefix length (0-32 or 0-128, depending on address family). |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| id | string | An example identifier (UUID). |\n| meta | object | Meta for the total of ACLs. |\n| name | string | Human readable name of store. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| action | string | One of \"ALLOW\" or \"BLOCK\". |\n| prefix | string | A valid IPv4 or IPv6 address and prefix in CIDR notation. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| action | string | The action taken on the IP address, either \"block\" or \"allow\". |\n| op | string | One of \"create\" or \"update\", indicating that the rest of this entry is to be added to/updated in the ACL. |\n| prefix | string | An IP prefix defined in Classless Inter-Domain Routing (CIDR) format, i.e. a valid IP address (v4 or v6) followed by a forward slash (/) and a prefix length (0-32 or 0-128, depending on address family). |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Authentication tokens",
"item": [
{
"name": "Automation Tokens",
"item": [
{
"name": "List Customer Automation Tokens",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/automation-tokens?page&per_page",
"host": [
"{{fastly_url}}"
],
"path": [
"automation-tokens"
],
"query": [
{
"key": "page"
},
{
"key": "per_page"
}
]
},
"description": "Lists all automation tokens for a customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/automation-tokens?page&per_page",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"automation-tokens"
],
"query": [
{
"key": "page"
},
{
"key": "per_page"
}
]
},
"description": "Lists all automation tokens for a customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"id\":\"FASTLY_AUTOMATION_TOKEN_ID\",\"customer_id\":\"FASTLY_CUSTOMER_ID\",\"creator_id\":\"FASTLY_USER_ID\",\"name\":\"automation-token\",\"role\":\"engineer\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\",\"scope\":\"global\",\"services\":[],\"tls_access\":false,\"last_used_at\":\"2022-06-07T20:43:14Z\",\"created_at\":\"2022-06-07T20:43:14Z\",\"expires_at\":\"2022-07-07T23:00:00Z\"}]"
}
]
},
{
"name": "Create Automation Token",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"my_automation_token\",\"expires_at\":null,\"role\":\"engineer\",\"services\":[],\"tls_access\":false}"
},
"url": {
"raw": "{{fastly_url}}/automation-tokens",
"host": [
"{{fastly_url}}"
],
"path": [
"automation-tokens"
]
},
"description": "Creates a new automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "201 Created",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"my_automation_token\",\"expires_at\":null,\"role\":\"engineer\",\"services\":[],\"tls_access\":false}"
},
"url": {
"raw": "https://api.fastly.com/automation-tokens",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"automation-tokens"
]
},
"description": "Creates a new automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "201 Created",
"code": 201,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"FASTLY_AUTOMATION_TOKEN_ID\",\"customer_id\":\"FASTLY_CUSTOMER_ID\",\"creator_id\":\"FASTLY_USER_ID\",\"name\":\"automation-token01\",\"access_token\":\"0FMUwOLYpTSaCX2BWhdSJhAtm9ubU3MC\",\"role\":\"engineer\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\",\"scope\":\"global\",\"services\":[],\"tls_access\":false,\"last_used_at\":\"2022-06-07T20:43:14Z\",\"created_at\":\"2022-06-07T20:43:14Z\",\"expires_at\":\"2022-06-07T23:00:00Z\"}"
}
]
},
{
"name": "Retrieve an Automation Token by ID",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/automation-tokens/{{id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"automation-tokens",
"{{id}}"
]
},
"description": "Retrieves an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/automation-tokens/{{id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"automation-tokens",
"{{id}}"
]
},
"description": "Retrieves an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"FASTLY_AUTOMATION_TOKEN_ID\",\"customer_id\":\"FASTLY_CUSTOMER_ID\",\"creator_id\":\"FASTLY_USER_ID\",\"name\":\"automation-token\",\"role\":\"engineer\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\",\"scope\":\"global\",\"services\":[],\"tls_access\":false,\"last_used_at\":\"2022-06-07T20:43:14Z\",\"created_at\":\"2022-06-07T20:43:14Z\",\"expires_at\":\"2022-07-07T23:00:00Z\"}"
}
]
},
{
"name": "Revoke an Automation Token by ID",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/automation-tokens/{{id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"automation-tokens",
"{{id}}"
]
},
"description": "Revoke an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/automation-tokens/{{id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"automation-tokens",
"{{id}}"
]
},
"description": "Revoke an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{}"
}
]
},
{
"name": "List Automation Token Services",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/automation-tokens/{{id}}/services?page&per_page",
"host": [
"{{fastly_url}}"
],
"path": [
"automation-tokens",
"{{id}}",
"services"
],
"query": [
{
"key": "page"
},
{
"key": "per_page"
}
]
},
"description": "List of services associated with the automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/automation-tokens/{{id}}/services?page&per_page",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"automation-tokens",
"{{id}}",
"services"
],
"query": [
{
"key": "page"
},
{
"key": "per_page"
}
]
},
"description": "List of services associated with the automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[\"SU1Z0isxPaozGVKXdv0eX\",\"SU1Z0isxPaozGVKXdv0eY\",\"SU1Z0isxPaozGVKXdv0eZ\"],\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":3,\"total_pages\":1}}"
}
]
}
],
"description": "Automation tokens differ from other token types because they are not tied to a specific person and therefore are not subject to the lifecycle of such accounts. Automation tokens are sometimes also called \"service accounts\". They are designed for API automation use-cases such as continuous integration, deployment pipelines, or automation scripts. For more information about authentication tokens, review the Authentication token documentation.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| expires_at | string | A UTC timestamp of when the token expires. |\n| name | string | The name of the token. |\n| role | string | The role on the token. |\n| scope | string | A space-delimited list of authorization scope. |\n| | global | This is the default scope covering all supported capabilities. |\n| | purge_select | Allows purging with surrogate key and URL. Disallows purging with purge-all. |\n| | purge_all | Allows purging an entire service via purge_all. |\n| | global:read | Allows read-only access to account information, configuration, and stats. |\n| services | array | (Optional) The service IDs of the services the token will have access to. Separate service IDs with a space. If no services are specified, the token will have access to all services on the account. |\n| tls_access | boolean | Indicates whether TLS access is enabled for the token. |\n| created_at | string | A UTC timestamp of when the token was created. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| id | string | Alphanumeric string identifying a token. |\n| last_used_at | string | A UTC timestamp of when the token was last used. |\n| user_agent | string | The User-Agent header of the client that last used the token. |\n| user_id | string | Alphanumeric string identifying the user. |\n| ip | string | The IP address of the client that last used the token. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "User tokens",
"item": [
{
"name": "List tokens for the authenticated user",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/tokens",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens"
]
},
"description": "List all tokens belonging to the authenticated user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/tokens",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens"
]
},
"description": "List all tokens belonging to the authenticated user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}]"
}
]
},
{
"name": "Create a token",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/tokens",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens"
]
},
"description": "Create an API token. If two-factor authentication is enabled for your account, review the instructions for including a one-time password in the request.\n> **Authorization**: Username and password, Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/tokens",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens"
]
},
"description": "Create an API token. If two-factor authentication is enabled for your account, review the instructions for including a one-time password in the request.\n> **Authorization**: Username and password, Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[\"5VqE6MOOy1QFJbgmCK41pY\",\"6VqE6MOOy1QFJbgmCK41pZ\"],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\",\"access_token\":\"YOUR_FASTLY_TOKEN\"}"
}
]
},
{
"name": "Revoke multiple tokens",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json; ext=bulk"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"token\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"token\"}]}"
},
"url": {
"raw": "{{fastly_url}}/tokens",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens"
]
},
"description": "Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json; ext=bulk"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"token\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"token\"}]}"
},
"url": {
"raw": "https://api.fastly.com/tokens",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens"
]
},
"description": "Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "List tokens for a customer",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/customer/{{customer_id}}/tokens",
"host": [
"{{fastly_url}}"
],
"path": [
"customer",
"{{customer_id}}",
"tokens"
]
},
"description": "List all tokens belonging to a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/tokens",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"customer",
"x4xCwxxJxGCx123Rx5xTx",
"tokens"
]
},
"description": "List all tokens belonging to a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}]"
}
]
},
{
"name": "Get the current token",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/tokens/self",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens",
"self"
]
},
"description": "Get a single token based on the access_token used in the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/tokens/self",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens",
"self"
]
},
"description": "Get a single token based on the access_token used in the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}"
}
]
},
{
"name": "Revoke the current token",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/tokens/self",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens",
"self"
]
},
"description": "Revoke a token that is used to authenticate the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/tokens/self",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens",
"self"
]
},
"description": "Revoke a token that is used to authenticate the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Get a token",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/tokens/{{token_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens",
"{{token_id}}"
]
},
"description": "Get a single token by its id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/tokens/5Yo3XXnrQpjc20u0ybrf2g",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens",
"5Yo3XXnrQpjc20u0ybrf2g"
]
},
"description": "Get a single token by its id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}"
}
]
},
{
"name": "Revoke a token",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/tokens/{{token_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"tokens",
"{{token_id}}"
]
},
"description": "Revoke a specific token by its id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/tokens/5Yo3XXnrQpjc20u0ybrf2g",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tokens",
"5Yo3XXnrQpjc20u0ybrf2g"
]
},
"description": "Revoke a specific token by its id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
}
],
"description": "An API Token is used to identify who is making the API call. Users can create multiple tokens to suit their needs.\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name of the token. |\n| scope | string | Space-delimited list of authorization scope. |\n| | global | This is the default scope covering all supported capabilities. |\n| | purge_select | Allows purging with surrogate key and URL. Disallows purging with purge-all. |\n| | purge_all | Allows purging an entire service via purge_all. |\n| | global:read | Allows read-only access to account information, configuration, and stats. |\n| services | array | List of alphanumeric strings identifying services (optional). If no services are specified, the token will have access to all services on the account. |\n| access_token | string | The alphanumeric string for accessing the API (only available on token creation). |\n| created_at | string | Time-stamp (UTC) of when the token was created. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| expires_at | string | Time-stamp (UTC) of when the token will expire (optional). |\n| id | string | Alphanumeric string identifying a token. |\n| ip | string | IP Address of the client that last used the token. |\n| last_used_at | string | Time-stamp (UTC) of when the token was last used. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| user_agent | string | User-Agent header of the client that last used the token. |\n| user_id | string | Alphanumeric string identifying the user. |"
}
]
},
{
"name": "Dictionaries",
"item": [
{
"name": "Dictionary info",
"item": [
{
"name": "Get dictionary metadata",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_id}}/info",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"dictionary",
"{{dictionary_id}}",
"info"
]
},
"description": "Retrieve metadata for a single dictionary by ID for a version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/3vjTN8v1O7nOAY7aNDGOL/info",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"info"
]
},
"description": "Retrieve metadata for a single dictionary by ID for a version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"item_count\":1,\"last_updated\":\"2020-06-04 19:23:11\",\"digest\":\"43ee763040973ca602549c94c5357a41c280afbb54e48d436af88f4e40d73081\"}"
}
]
}
],
"description": "Dictionary Info is a set of metadata describing properties of a dictionary which change as items are added and removed.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| digest | string | A hash of all the dictionary content. |\n| item_count | integer | The number of items currently in the dictionary. |\n| last_updated | string | Timestamp (UTC) when the dictionary was last updated or an item was added or removed. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Dictionary item",
"item": [
{
"name": "List items in a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/items?direction&page&per_page&sort",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"items"
],
"query": [
{
"key": "direction",
"description": "Direction in which to sort results."
},
{
"key": "page",
"description": "Current page."
},
{
"key": "per_page",
"description": "Number of records per page."
},
{
"key": "sort",
"description": "Field on which to sort."
}
]
},
"description": "List of DictionaryItems given service and dictionary ID.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/items?direction=ascend&page=1&per_page=20&sort=created?direction&page&per_page&sort",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"items"
],
"query": [
{
"key": "direction",
"description": "Direction in which to sort results."
},
{
"key": "page",
"description": "Current page."
},
{
"key": "per_page",
"description": "Number of records per page."
},
{
"key": "sort",
"description": "Field on which to sort."
}
]
},
"description": "List of DictionaryItems given service and dictionary ID.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}]"
}
]
},
{
"name": "Update multiple entries in a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"items\":[{\"op\":\"create\",\"item_key\":\"test-key\",\"item_value\":\"new-value\"},{\"op\":\"update\",\"item_key\":\"test-key-2\",\"item_value\":\"new-value-2\"},{\"op\":\"upsert\",\"item_key\":\"test-key-3\",\"item_value\":\"new-value-3\"},{\"op\":\"delete\",\"item_key\":\"test-key-4\"}]}"
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/items",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"items"
]
},
"description": "Update multiple items in the same dictionary. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 items. Contact support to discuss raising this limit.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"items\":[{\"op\":\"create\",\"item_key\":\"test-key\",\"item_value\":\"new-value\"},{\"op\":\"update\",\"item_key\":\"test-key-2\",\"item_value\":\"new-value-2\"},{\"op\":\"upsert\",\"item_key\":\"test-key-3\",\"item_value\":\"new-value-3\"},{\"op\":\"delete\",\"item_key\":\"test-key-4\"}]}"
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/items",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"items"
]
},
"description": "Update multiple items in the same dictionary. For faster updates to your service, group your changes into large batches. The maximum batch size is 1000 items. Contact support to discuss raising this limit.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
},
{
"name": "Get an item from a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"item",
"{{dictionary_item_key}}"
]
},
"description": "Retrieve a single DictionaryItem given service, dictionary ID and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"item",
"test-key"
]
},
"description": "Retrieve a single DictionaryItem given service, dictionary ID and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
},
{
"name": "Insert or update an entry in a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"item",
"{{dictionary_item_key}}"
]
},
"description": "Upsert DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"item",
"test-key"
]
},
"description": "Upsert DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
},
{
"name": "Delete an item from a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"item",
"{{dictionary_item_key}}"
]
},
"description": "Delete DictionaryItem given service, dictionary ID, and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"item",
"test-key"
]
},
"description": "Delete DictionaryItem given service, dictionary ID, and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
},
{
"name": "Update an entry in a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"item",
"{{dictionary_item_key}}"
]
},
"description": "Update DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"item",
"test-key"
]
},
"description": "Update DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
},
{
"name": "Create an entry in a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"dictionary",
"{{dictionary_id}}",
"item"
]
},
"description": "Create DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"dictionary",
"3vjTN8v1O7nOAY7aNDGOL",
"item"
]
},
"description": "Create DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}"
}
]
}
],
"description": "A Dictionary Item is a single key-value pair that makes up an entry in a Dictionary. Dictionary Items can be added, removed and modified without activating a new version of the associated service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| item_key | string | Item key, maximum 256 characters. |\n| item_value | string | Item value, maximum 8000 characters. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| dictionary_id | string | Alphanumeric string identifying a Dictionary. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Dictionary",
"item": [
{
"name": "List dictionaries",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"dictionary"
]
},
"description": "List all dictionaries for the version of the service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"dictionary"
]
},
"description": "List all dictionaries for the version of the service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}]"
}
]
},
{
"name": "Create a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"dictionary"
]
},
"description": "Create named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"dictionary"
]
},
"description": "Create named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}"
}
]
},
{
"name": "Get a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"dictionary",
"{{dictionary_name}}"
]
},
"description": "Retrieve a single dictionary by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/test_dictionary",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"dictionary",
"test_dictionary"
]
},
"description": "Retrieve a single dictionary by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}"
}
]
},
{
"name": "Update a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"dictionary",
"{{dictionary_name}}"
]
},
"description": "Update named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/test_dictionary",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"dictionary",
"test_dictionary"
]
},
"description": "Update named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}"
}
]
},
{
"name": "Delete a dictionary",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"dictionary",
"{{dictionary_name}}"
]
},
"description": "Delete named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/test_dictionary",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"dictionary",
"test_dictionary"
]
},
"description": "Delete named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "A Dictionary is a VCL data table that stores key-value pairs accessible to VCL during request processing. New, empty dictionaries can be attached to a draft version of a service, which must be activated for the dictionary to be included in VCL. Once installed, a dictionary's items may be updated via API calls without having to activate a new version of the associated service configuration. To remove a dictionary, delete it on a draft version of a service (one that is not locked and not active). Once removed, activate the draft service version without the dictionary.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace). |\n| write_only | boolean | Determines if items in the dictionary are readable or not. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a Dictionary. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Subscriber Provided Prefix (SPP)",
"item": [
{
"name": "DNS Configuration",
"item": [
{
"name": "List DNS configurations",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/dns/configurations",
"host": [
"{{fastly_url}}"
],
"path": [
"dns",
"configurations"
]
},
"description": "List all DNS configurations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 List of DNS configurations.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/dns/configurations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"dns",
"configurations"
]
},
"description": "List all DNS configurations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 List of DNS configurations.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"DNS_CONFIGURATION_ID\",\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true,\"name\":\"example_customer.customer.fastly.net\",\"region\":\"global\"},\"relationships\":{\"tls_configuration\":{\"data\":{\"id\":\"TLS_CONFIGURATION_ID\",\"type\":\"tls_configuration\"}}}}]}"
}
]
},
{
"name": "Create a DNS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true,\"name\":\"example_customer.customer.fastly.net\"},\"relationships\":{\"tls_configuration\":{\"data\":{\"id\":\"TLS_CONFIGURATION_ID\",\"type\":\"tls_configuration\"}}}}}"
},
"url": {
"raw": "{{fastly_url}}/dns/configurations",
"host": [
"{{fastly_url}}"
],
"path": [
"dns",
"configurations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/dns-configuration/#create-spp-dns-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "201 A DNS configuration.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true,\"name\":\"example_customer.customer.fastly.net\"},\"relationships\":{\"tls_configuration\":{\"data\":{\"id\":\"TLS_CONFIGURATION_ID\",\"type\":\"tls_configuration\"}}}}}"
},
"url": {
"raw": "https://api.fastly.com/dns/configurations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"dns",
"configurations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/dns-configuration/#create-spp-dns-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "201 A DNS configuration.",
"code": 201,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"DNS_CONFIGURATION_ID\",\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true,\"name\":\"example_customer.customer.fastly.net\",\"region\":\"global\"},\"relationships\":{\"tls_configuration\":{\"data\":{\"id\":\"TLS_CONFIGURATION_ID\",\"type\":\"tls_configuration\"}}}}}"
}
]
},
{
"name": "Get a DNS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/dns/configurations/{{dns_configuration_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"dns",
"configurations",
"{{dns_configuration_id}}"
]
},
"description": "Show a specific DNS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 A DNS configuration.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/dns/configurations/{{dns_configuration_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"dns",
"configurations",
"{{dns_configuration_id}}"
]
},
"description": "Show a specific DNS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 A DNS configuration.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"DNS_CONFIGURATION_ID\",\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true,\"name\":\"example_customer.customer.fastly.net\",\"region\":\"global\"},\"relationships\":{\"tls_configuration\":{\"data\":{\"id\":\"TLS_CONFIGURATION_ID\",\"type\":\"tls_configuration\"}}}}}"
}
]
},
{
"name": "Delete a DNS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/dns/configurations/{{dns_configuration_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"dns",
"configurations",
"{{dns_configuration_id}}"
]
},
"description": "Remove a DNS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/dns/configurations/{{dns_configuration_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"dns",
"configurations",
"{{dns_configuration_id}}"
]
},
"description": "Remove a DNS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Update a DNS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"id\":\"DNS_CONFIGURATION_ID\",\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true}}}"
},
"url": {
"raw": "{{fastly_url}}/dns/configurations/{{dns_configuration_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"dns",
"configurations",
"{{dns_configuration_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/dns-configuration/#update-spp-dns-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 A DNS configuration.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"id\":\"DNS_CONFIGURATION_ID\",\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true}}}"
},
"url": {
"raw": "https://api.fastly.com/dns/configurations/{{dns_configuration_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"dns",
"configurations",
"{{dns_configuration_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/dns-configuration/#update-spp-dns-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 A DNS configuration.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"DNS_CONFIGURATION_ID\",\"type\":\"dns_configuration\",\"attributes\":{\"dualstack\":true,\"name\":\"example_customer.customer.fastly.net\",\"region\":\"global\"},\"relationships\":{\"tls_configuration\":{\"data\":{\"id\":\"TLS_CONFIGURATION_ID\",\"type\":\"tls_configuration\"}}}}}"
}
]
}
],
"description": "Customers with access to multiple sets of IP pools are able to manage DNS records associated with the IP pools.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | The CNAME record for your DNS Configuration. It must be a valid FQDN that starts with a custom label and ends with.customer.fastly.com (e.g., example.customer.fastly.net). Supported characters for the custom label include a-z, 0-9, hyphens, and underscores. |\n| dualstack | boolean | True shows this DNS configuration is using both IPv4 (default) and IPv6 (optional). False shows it is using IPv4 only. When not provided, we will default to false. |\n| region | string | The region string will be “global” for all configurations involving the customer’s SPP vipspace. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dualstack | boolean | True shows this DNS configuration is using both IPv4 (default) and IPv6 (optional). False shows it is using IPv4 only. When not provided, we will default to false. |\n| name | string | The CNAME record for your DNS Configuration. It must be a valid FQDN that starts with a custom label and ends with.customer.fastly.com (e.g., example.customer.fastly.net). Supported characters for the custom label include a-z, 0-9, hyphens, and underscores. |\n| relationships.tls_configuration.id | string | Alphanumeric string identifying a TLS configuration. |\n| type | string | Resource type. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dualstack | boolean | True shows this DNS configuration is using both IPv4 (default) and IPv6 (optional). False shows it is using IPv4 only. When not provided, we will default to false. |\n| id | string | Alphanumeric string identifying a DNS configuration. |\n| name | string | The CNAME record for your DNS Configuration. It must be a valid FQDN that starts with a custom label and ends with.customer.fastly.com (e.g., example.customer.fastly.net). Supported characters for the custom label include a-z, 0-9, hyphens, and underscores. |\n| region | string | The region string will be “global” for all configurations involving the customer’s SPP vipspace. |\n| relationships.tls_configuration.id | string | Alphanumeric string identifying a TLS configuration. |\n| type | string | Resource type. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dualstack | boolean | True shows this DNS configuration is using both IPv4 (default) and IPv6 (optional). False shows it is using IPv4 only. When not provided, we will default to false. |\n| type | string | Resource type. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "TLS Configuration",
"item": [
{
"name": "List TLS configurations",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/tls/configurations?filter[bulk]&include&page[number]&page[size]",
"host": [
"{{fastly_url}}"
],
"path": [
"tls",
"configurations"
],
"query": [
{
"key": "filter[bulk]",
"description": "Optionally filters by the bulk attribute."
},
{
"key": "include",
"description": "Include related objects. Optional, comma-separated values. Permitted values: dns_records."
},
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
}
]
},
"description": "List all TLS configurations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 List of TLS configurations.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=20?filter[bulk]&include&page[number]&page[size]",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tls",
"configurations"
],
"query": [
{
"key": "filter[bulk]",
"description": "Optionally filters by the bulk attribute."
},
{
"key": "include",
"description": "Include related objects. Optional, comma-separated values. Permitted values: dns_records."
},
{
"key": "page[number]",
"description": "Current page."
},
{
"key": "page[size]",
"description": "Number of records per page."
}
]
},
"description": "List all TLS configurations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 List of TLS configurations.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"TLS Configuration A\",\"tls_1_2_cipher_suite_profile\":[\"ECDHE-RSA-AES256-GCM-SHA384\",\"...\"],\"tls_1_3_cipher_suite_profile\":[\"TLS_AES_256_GCM_SHA384\",\"...\"],\"tls_protocols\":[\"1.1\",\"1.2\"],\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"vipspace\":\"customer_assigned_vipspace\"},\"relationships\":{\"dns_records\":{\"data\":[{\"id\":\"23.154.64.3\",\"type\":\"dns_record\"},{\"id\":\"spp-test.customer.fastly.net\",\"type\":\"dns_record\"},{\"id\":\"2620:11a:c004::3\",\"type\":\"dns_record\"}]},\"service\":{\"data\":{\"id\":\"VKXdv0eYSU1Z0isxPaozG\",\"type\":\"service\"}},\"default_certificate\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"5YwbK89STDIW0UYejRRUmG\",\"type\":\"tls_certificate\"}}}}],\"included\":[{\"id\":\"23.154.64.3\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"spp-test.customer.fastly.net\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"CNAME\",\"region\":\"global\"}},{\"id\":\"2620:11a:c004::3\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"AAAA\",\"region\":\"global\"}}],\"links\":{\"self\":\"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"first\":\"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=100\"},\"meta\":{\"per_page\":100,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}"
}
]
},
{
"name": "Create a TLS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"tls_configuration\",\"attributes\":{\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"New TLS Configuration\",\"tls_protocols\":[\"1.2\",\"1.3\"],\"tls_1_2_cipher_suite_profile\":[\"ECDHE-RSA-AES256-GCM-SHA384\",\"...\"],\"vipspace\":\"customer_assigned_vipspace\"},\"relationships\":{\"dns_records\":{\"data\":[{\"id\":\"IPV4_ADDRESS\",\"type\":\"dns_record\"}]},\"default_certificate\":{\"data\":{\"id\":\"DEFAULT_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"DEFAULT_ECDSA_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}}}}}"
},
"url": {
"raw": "{{fastly_url}}/tls/configurations",
"host": [
"{{fastly_url}}"
],
"path": [
"tls",
"configurations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/tls-configuration/#create-spp-tls-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "201 A TLS configuration.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"type\":\"tls_configuration\",\"attributes\":{\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"New TLS Configuration\",\"tls_protocols\":[\"1.2\",\"1.3\"],\"tls_1_2_cipher_suite_profile\":[\"ECDHE-RSA-AES256-GCM-SHA384\",\"...\"],\"vipspace\":\"customer_assigned_vipspace\"},\"relationships\":{\"dns_records\":{\"data\":[{\"id\":\"IPV4_ADDRESS\",\"type\":\"dns_record\"}]},\"default_certificate\":{\"data\":{\"id\":\"DEFAULT_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"DEFAULT_ECDSA_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}}}}}"
},
"url": {
"raw": "https://api.fastly.com/tls/configurations",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tls",
"configurations"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/tls-configuration/#create-spp-tls-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "201 A TLS configuration.",
"code": 201,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"TLS Configuration A\",\"tls_protocols\":[\"1.1\",\"1.2\"],\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"vipspace\":\"customer_assigned_vipspace\"},\"relationships\":{\"default_certificate\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"5YwbK89STDIW0UYejRRUmG\",\"type\":\"tls_certificate\"}}}}}"
}
]
},
{
"name": "Get a TLS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "{{fastly_url}}/tls/configurations/{{tls_configuration_id}}?include",
"host": [
"{{fastly_url}}"
],
"path": [
"tls",
"configurations",
"{{tls_configuration_id}}"
],
"query": [
{
"key": "include",
"description": "Include related objects. Optional, comma-separated values. Permitted values: dns_records."
}
]
},
"description": "Show a specific TLS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 A TLS configuration.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"url": {
"raw": "https://api.fastly.com/tls/configurations/{{tls_configuration_id}}?include=dns_records?include",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tls",
"configurations",
"{{tls_configuration_id}}"
],
"query": [
{
"key": "include",
"description": "Include related objects. Optional, comma-separated values. Permitted values: dns_records."
}
]
},
"description": "Show a specific TLS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 A TLS configuration.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"TLS Configuration A\",\"tls_1_2_cipher_suite_profile\":[\"ECDHE-RSA-AES256-GCM-SHA384\",\"...\"],\"tls_1_3_cipher_suite_profile\":[\"TLS_AES_256_GCM_SHA384\",\"...\"],\"tls_protocols\":[\"1.1\",\"1.2\"],\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"vipspace\":\"customer_assigned_vipspace\"},\"relationships\":{\"dns_records\":{\"data\":[{\"id\":\"23.154.64.3\",\"type\":\"dns_record\"},{\"id\":\"spp-test.customer.fastly.net\",\"type\":\"dns_record\"},{\"id\":\"2620:11a:c004::3\",\"type\":\"dns_record\"}]},\"service\":{\"data\":{\"id\":\"VKXdv0eYSU1Z0isxPaozG\",\"type\":\"service\"}},\"default_certificate\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"5YwbK89STDIW0UYejRRUmG\",\"type\":\"tls_certificate\"}}}},\"included\":[{\"id\":\"23.154.64.3\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"spp-test.customer.fastly.net\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"CNAME\",\"region\":\"global\"}},{\"id\":\"2620:11a:c004::3\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"AAAA\",\"region\":\"global\"}}]}"
}
]
},
{
"name": "Delete a TLS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/tls/configurations/{{tls_configuration_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"tls",
"configurations",
"{{tls_configuration_id}}"
]
},
"description": "Remove a TLS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/tls/configurations/{{tls_configuration_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tls",
"configurations",
"{{tls_configuration_id}}"
]
},
"description": "Remove a TLS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Update a TLS configuration",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"New TLS Configuration\",\"tls_protocols\":[\"1.2\",\"1.3\"],\"tls_1_2_cipher_suite_profile\":[\"ECDHE-RSA-AES256-GCM-SHA384\",\"...\"]},\"relationships\":{\"default_certificate\":{\"data\":{\"id\":\"DEFAULT_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"DEFAULT_ECDSA_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}}}}}"
},
"url": {
"raw": "{{fastly_url}}/tls/configurations/{{tls_configuration_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"tls",
"configurations",
"{{tls_configuration_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/tls-configuration/#update-spp-tls-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 A TLS configuration.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "Accept",
"value": "application/vnd.api+json"
}
],
"body": {
"mode": "raw",
"raw": "{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"New TLS Configuration\",\"tls_protocols\":[\"1.2\",\"1.3\"],\"tls_1_2_cipher_suite_profile\":[\"ECDHE-RSA-AES256-GCM-SHA384\",\"...\"]},\"relationships\":{\"default_certificate\":{\"data\":{\"id\":\"DEFAULT_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"DEFAULT_ECDSA_CERTIFICATE_ID\",\"type\":\"tls_certificate\"}}}}}"
},
"url": {
"raw": "https://api.fastly.com/tls/configurations/{{tls_configuration_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"tls",
"configurations",
"{{tls_configuration_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/ip-configuration/spp/tls-configuration/#update-spp-tls-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 A TLS configuration.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"TLS Configuration A\",\"tls_protocols\":[\"1.1\",\"1.2\"],\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"vipspace\":\"customer_assigned_vipspace\"},\"relationships\":{\"default_certificate\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"tls_certificate\"}},\"default_ecdsa_certificate\":{\"data\":{\"id\":\"5YwbK89STDIW0UYejRRUmG\",\"type\":\"tls_certificate\"}}}}}"
}
]
}
],
"description": "Customers with access to multiple sets of IP pools can apply different configuration options to their TLS-enabled domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| http_protocols | array | HTTP protocols available on your configuration. At least one protocol is required:\n\nhttp/1.1 is always supported and is required in the array.\nhttp/2 is optionally supported in the array.\nhttp/3 is optionally supported in the array. |\n| name | string | A custom name for your TLS configuration. Optional, we will assign a value to this if none is provided. |\n| tls_1_2_cipher_suite_profile | array | An ordered collection of OpenSSL-formatted cipher suite names used for TLS-1.0, TLS-1.1 and TLS-1.2 protocol versions.\nNote: Setting this field is an advanced feature that requires enablement by Fastly Support. |\n| tls_protocols | array | TLS protocols available on your configuration. The following TLS protocols are supported:\n\n[“1.0”, “1.1”, “1.2”] \n[“1.0”, “1.1”, “1.2”, “1.3”] \n[“1.0”, “1.1”, “1.2”, “1.3+0RTT”] \n[“1.2”]\n[“1.2”, “1.3”]\n[“1.2”, “1.3+0RTT”]. |\n| vipspace | string | A Fastly assigned name representing a set of network prefixes that are available for operations like acquiring TLS configurations.\nThis field is Required, and must be customer_assigned_vipspace. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| http_protocols | array | HTTP protocols available on your configuration. At least one protocol is required:\n\nhttp/1.1 is always supported and is required in the array.\nhttp/2 is optionally supported in the array.\nhttp/3 is optionally supported in the array. |\n| name | string | A custom name for your TLS configuration. Optional, we will assign a value to this if none is provided. |\n| relationships.default_certificate.id | string | Alphanumeric string identifying the default TLS certificate. |\n| relationships.default_ecdsa_certificate.id | string | Alphanumeric string identifying the default ECDSA TLS certificate. |\n| relationships.dns_records.id | string | The IPv4 address that will be used for your TLS configuration. Note: Setting this field is an advanced feature that requires enablement by Fastly Support. |\n| tls_1_2_cipher_suite_profile | array | An ordered collection of OpenSSL-formatted cipher suite names used for TLS-1.0, TLS-1.1 and TLS-1.2 protocol versions.\nNote: Setting this field is an advanced feature that requires enablement by Fastly Support. |\n| tls_protocols | array | TLS protocols available on your configuration. The following TLS protocols are supported:\n\n[“1.0”, “1.1”, “1.2”] \n[“1.0”, “1.1”, “1.2”, “1.3”] \n[“1.0”, “1.1”, “1.2”, “1.3+0RTT”] \n[“1.2”]\n[“1.2”, “1.3”]\n[“1.2”, “1.3+0RTT”]. |\n| type | string | Resource type. |\n| vipspace | string | A Fastly assigned name representing a set of network prefixes that are available for operations like acquiring TLS configurations.\nThis field is Required, and must be customer_assigned_vipspace. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bulk | boolean | Signifies whether the configuration is used for Platform TLS or not. We will always assume for this product \nthat the value for this is “false”, signifying you have full access to the main set of APIs for custom\nTLS certificates and\nTLS subscriptions, as well as the\nTLS management UI. |\n| created_at | string | Date and time in ISO 8601 format. |\n| default | boolean | Signifies whether or not Fastly will use this configuration as a default when creating a new\nTLS activation. |\n| http_protocols | array | HTTP protocols available on your configuration. At least one protocol is required:\n\nhttp/1.1 is always supported and is required in the array.\nhttp/2 is optionally supported in the array.\nhttp/3 is optionally supported in the array. |\n| id | string | Alphanumeric string identifying a TLS configuration. |\n| name | string | A custom name for your TLS configuration. Optional, we will assign a value to this if none is provided. |\n| relationships.default_certificate.id | string | Alphanumeric string identifying the default TLS certificate. |\n| relationships.default_ecdsa_certificate.id | string | Alphanumeric string identifying the default ECDSA TLS certificate. |\n| relationships.dns_records.id | string | The IP address or hostname of the DNS record. |\n| relationships.service.id | string | Alphanumeric string identifying the service. |\n| tls_1_2_cipher_suite_profile | array | An ordered collection of OpenSSL-formatted cipher suite names used for TLS-1.0, TLS-1.1 and TLS-1.2 protocol versions.\nNote: Setting this field is an advanced feature that requires enablement by Fastly Support. |\n| tls_1_3_cipher_suite_profile | array | An ordered collection of OpenSSL-formatted cipher suite names used for TLS-1.3. \nIf TLS-1.3 is selected, you will get the default list. |\n| tls_protocols | array | TLS protocols available on your configuration. The following TLS protocols are supported:\n\n[“1.0”, “1.1”, “1.2”] \n[“1.0”, “1.1”, “1.2”, “1.3”] \n[“1.0”, “1.1”, “1.2”, “1.3+0RTT”] \n[“1.2”]\n[“1.2”, “1.3”]\n[“1.2”, “1.3+0RTT”]. |\n| type | string | Resource type. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| vipspace | string | A Fastly assigned name representing a set of network prefixes that are available for operations like acquiring TLS configurations.\nThis field is Required, and must be customer_assigned_vipspace. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| http_protocols | array | HTTP protocols available on your configuration. At least one protocol is required:\n\nhttp/1.1 is always supported and is required in the array.\nhttp/2 is optionally supported in the array.\nhttp/3 is optionally supported in the array. |\n| name | string | A custom name for your TLS configuration. Optional, we will assign a value to this if none is provided. |\n| relationships.default_certificate.id | string | Alphanumeric string identifying the default TLS certificate. |\n| relationships.default_ecdsa_certificate.id | string | Alphanumeric string identifying the default ECDSA TLS certificate. |\n| tls_1_2_cipher_suite_profile | array | An ordered collection of OpenSSL-formatted cipher suite names used for TLS-1.0, TLS-1.1 and TLS-1.2 protocol versions.\nNote: Setting this field is an advanced feature that requires enablement by Fastly Support. |\n| tls_protocols | array | TLS protocols available on your configuration. The following TLS protocols are supported:\n\n[“1.0”, “1.1”, “1.2”] \n[“1.0”, “1.1”, “1.2”, “1.3”] \n[“1.0”, “1.1”, “1.2”, “1.3+0RTT”] \n[“1.2”]\n[“1.2”, “1.3”]\n[“1.2”, “1.3+0RTT”]. |\n| type | string | Resource type. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Real-time logging",
"item": [
{
"name": "Microsoft Azure Blob Storage",
"item": [
{
"name": "List Azure Blob Storage log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"azureblob"
]
},
"description": "List all of the Azure Blob Storage logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"azureblob"
]
},
"description": "List all of the Azure Blob Storage logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"format_version\":\"2\",\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":\"3600\",\"name\":\"test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}]"
}
]
},
{
"name": "Create an Azure Blob Storage log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"azureblob"
]
},
"description": "Create an Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"azureblob"
]
},
"description": "Create an Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"format_version\":\"2\",\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":\"3600\",\"name\":\"test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}"
}
]
},
{
"name": "Get an Azure Blob Storage log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob/{{logging_azureblob_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"azureblob",
"{{logging_azureblob_name}}"
]
},
"description": "Get the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"azureblob",
"test-log-endpoint"
]
},
"description": "Get the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"format_version\":\"2\",\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":\"3600\",\"name\":\"test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}"
}
]
},
{
"name": "Update an Azure Blob Storage log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob/{{logging_azureblob_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"azureblob",
"{{logging_azureblob_name}}"
]
},
"description": "Update the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"azureblob",
"test-log-endpoint"
]
},
"description": "Update the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"format_version\":\"2\",\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":\"3600\",\"name\":\"updated-test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}"
}
]
},
{
"name": "Delete the Azure Blob Storage log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob/{{logging_azureblob_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"azureblob",
"{{logging_azureblob_name}}"
]
},
"description": "Delete the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"azureblob",
"test-log-endpoint"
]
},
"description": "Delete the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the Azure Blob Storage container in the format specified in the Azure Blob object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| account_name | string | The unique Azure Blob Storage namespace in which your data objects are stored. Required. |\n| container | string | The name of the Azure Blob Storage container in which to store logs. Required. |\n| file_max_bytes | integer | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB). Note that Microsoft Azure Storage has block size limits. |\n| path | string | The path to upload logs to. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| sas_token | string | The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "BigQuery",
"item": [
{
"name": "List BigQuery log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"bigquery"
]
},
"description": "List all of the BigQuery logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"bigquery"
]
},
"description": "List all of the BigQuery logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}]"
}
]
},
{
"name": "Create a BigQuery log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"bigquery"
]
},
"description": "Create a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"bigquery"
]
},
"description": "Create a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Get a BigQuery log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery/{{logging_bigquery_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"bigquery",
"{{logging_bigquery_name}}"
]
},
"description": "Get the details for a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"bigquery",
"test-log-endpoint"
]
},
"description": "Get the details for a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Update a BigQuery log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery/{{logging_bigquery_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"bigquery",
"{{logging_bigquery_name}}"
]
},
"description": "Update a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"bigquery",
"test-log-endpoint"
]
},
"description": "Update a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Delete a BigQuery log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery/{{logging_bigquery_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"bigquery",
"{{logging_bigquery_name}}"
]
},
"description": "Delete a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"bigquery",
"test-log-endpoint"
]
},
"description": "Delete a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the Google BigQuery dataset and table in the format specified in the BigQuery logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dataset | string | Your BigQuery dataset. |\n| format | string | A Fastly log format string. Must produce JSON that matches the schema of your BigQuery table. |\n| name | string | The name of the BigQuery logging object. Used as a primary key for API access. |\n| project_id | string | Your Google Cloud Platform project ID. Required. |\n| table | string | Your BigQuery table. |\n| template_suffix | string | BigQuery table name suffix template. Optional. |\n| account_name | string | The name of the Google Cloud Platform service account associated with the target log collection service. Not required if user and secret_key are provided. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified. |\n| user | string | Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Not required if account_name is specified. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Cloud Files",
"item": [
{
"name": "List Cloud Files log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"cloudfiles"
]
},
"description": "List all of the Cloud Files log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"cloudfiles"
]
},
"description": "List all of the Cloud Files log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"period\":\"3600\",\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":\"1\",\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":\"2\"}]"
}
]
},
{
"name": "Create a Cloud Files log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"cloudfiles"
]
},
"description": "Create a Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"cloudfiles"
]
},
"description": "Create a Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"period\":\"3600\",\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":\"1\",\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":\"2\"}"
}
]
},
{
"name": "Get a Cloud Files log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles/{{logging_cloudfiles_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"cloudfiles",
"{{logging_cloudfiles_name}}"
]
},
"description": "Get the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"cloudfiles",
"test-log-endpoint"
]
},
"description": "Get the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"period\":\"3600\",\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":\"1\",\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":\"2\"}"
}
]
},
{
"name": "Update the Cloud Files log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles/{{logging_cloudfiles_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"cloudfiles",
"{{logging_cloudfiles_name}}"
]
},
"description": "Update the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"cloudfiles",
"test-log-endpoint"
]
},
"description": "Update the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"updated-test-log-endpoint\",\"period\":\"3600\",\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":\"1\",\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":\"2\"}"
}
]
},
{
"name": "Delete the Cloud Files log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles/{{logging_cloudfiles_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"cloudfiles",
"{{logging_cloudfiles_name}}"
]
},
"description": "Delete the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"cloudfiles",
"test-log-endpoint"
]
},
"description": "Delete the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to your Rackspace Cloud Files account.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | Your Cloud Files account access key. |\n| bucket_name | string | The name of your Cloud Files container. |\n| path | string | The path to upload logs to. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| region | string | The region to stream logs to. |\n| | DFW | Dallas. |\n| | ORD | Chicago. |\n| | IAD | Northern Virginia. |\n| | LON | London. |\n| | SYD | Sydney. |\n| | HKG | Hong Kong. |\n| | null | |\n| user | string | The username for your Cloud Files account. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Datadog",
"item": [
{
"name": "List Datadog log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"datadog"
]
},
"description": "List all of the Datadog logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"datadog"
]
},
"description": "List all of the Datadog logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":\"2\",\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}]"
}
]
},
{
"name": "Create a Datadog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"datadog"
]
},
"description": "Create a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"datadog"
]
},
"description": "Create a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":\"2\",\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}"
}
]
},
{
"name": "Get a Datadog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog/{{logging_datadog_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"datadog",
"{{logging_datadog_name}}"
]
},
"description": "Get the details for a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"datadog",
"test-log-endpoint"
]
},
"description": "Get the details for a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":\"2\",\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}"
}
]
},
{
"name": "Update a Datadog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog/{{logging_datadog_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"datadog",
"{{logging_datadog_name}}"
]
},
"description": "Update the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"datadog",
"test-log-endpoint"
]
},
"description": "Update the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":\"2\",\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}"
}
]
},
{
"name": "Delete a Datadog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog/{{logging_datadog_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"datadog",
"{{logging_datadog_name}}"
]
},
"description": "Delete the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"datadog",
"test-log-endpoint"
]
},
"description": "Delete the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to Datadog in the format specified in the Datadog configuration object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. Must produce valid JSON that Datadog can ingest. |\n| region | string | The region that log data will be sent to. |\n| token | string | The API key from your Datadog account. Required. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "DigitalOcean Spaces",
"item": [
{
"name": "List DigitalOcean Spaces log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"digitalocean"
]
},
"description": "List all of the DigitalOcean Spaces for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"digitalocean"
]
},
"description": "List all of the DigitalOcean Spaces for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create a DigitalOcean Spaces log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"digitalocean"
]
},
"description": "Create a DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"digitalocean"
]
},
"description": "Create a DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Get a DigitalOcean Spaces log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean/{{logging_digitalocean_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"digitalocean",
"{{logging_digitalocean_name}}"
]
},
"description": "Get the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"digitalocean",
"test-log-endpoint"
]
},
"description": "Get the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Update a DigitalOcean Spaces log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean/{{logging_digitalocean_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"digitalocean",
"{{logging_digitalocean_name}}"
]
},
"description": "Update the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"digitalocean",
"test-log-endpoint"
]
},
"description": "Update the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete a DigitalOcean Spaces log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean/{{logging_digitalocean_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"digitalocean",
"{{logging_digitalocean_name}}"
]
},
"description": "Delete the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"digitalocean",
"test-log-endpoint"
]
},
"description": "Delete the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the DigitalOcean Space in the format specified in the DigitalOcean Spaces object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | Your DigitalOcean Spaces account access key. |\n| bucket_name | string | The name of the DigitalOcean Space. |\n| domain | string | The domain of the DigitalOcean Spaces endpoint. |\n| path | string | The path to upload logs to. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| secret_key | string | Your DigitalOcean Spaces account secret key. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Elasticsearch",
"item": [
{
"name": "List Elasticsearch log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"elasticsearch"
]
},
"description": "List all of the Elasticsearch logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"elasticsearch"
]
},
"description": "List all of the Elasticsearch logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"format_version\":\"2\",\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":\"1\",\"name\":\"test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}]"
}
]
},
{
"name": "Create an Elasticsearch log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"elasticsearch"
]
},
"description": "Create a Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"elasticsearch"
]
},
"description": "Create a Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format_version\":\"2\",\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":\"1\",\"name\":\"test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}"
}
]
},
{
"name": "Get an Elasticsearch log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch/{{logging_elasticsearch_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"elasticsearch",
"{{logging_elasticsearch_name}}"
]
},
"description": "Get the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"elasticsearch",
"test-log-endpoint"
]
},
"description": "Get the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format_version\":\"2\",\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":\"1\",\"name\":\"test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}"
}
]
},
{
"name": "Update an Elasticsearch log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch/{{logging_elasticsearch_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"elasticsearch",
"{{logging_elasticsearch_name}}"
]
},
"description": "Update the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"elasticsearch",
"test-log-endpoint"
]
},
"description": "Update the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format_version\":\"2\",\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":\"1\",\"name\":\"updated-test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}"
}
]
},
{
"name": "Delete an Elasticsearch log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch/{{logging_elasticsearch_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"elasticsearch",
"{{logging_elasticsearch_name}}"
]
},
"description": "Delete the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"elasticsearch",
"test-log-endpoint"
]
},
"description": "Delete the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages periodically to the server in the format specified in the Elasticsearch object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. Must produce valid JSON that Elasticsearch can ingest. |\n| index | string | The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch index format rules. We support strftime interpolated variables inside braces prefixed with a pound symbol. For example, #{%F} will interpolate as YYYY-MM-DD with today's date. |\n| password | string | Basic Auth password. |\n| pipeline | string | The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the Elasticsearch docs. |\n| url | string | The URL to stream logs to. Must use HTTPS. |\n| user | string | Basic Auth username. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 for unbounded. |\n| request_max_entries | integer | The maximum number of logs sent in one request. Defaults 0 for unbounded. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "FTP",
"item": [
{
"name": "List FTP log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"ftp"
]
},
"description": "List all of the FTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"ftp"
]
},
"description": "List all of the FTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"21\",\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create an FTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"ftp"
]
},
"description": "Create a FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"ftp"
]
},
"description": "Create a FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"21\",\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}"
}
]
},
{
"name": "Get an FTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp/{{logging_ftp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"ftp",
"{{logging_ftp_name}}"
]
},
"description": "Get the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"ftp",
"test-log-endpoint"
]
},
"description": "Get the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"21\",\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}"
}
]
},
{
"name": "Update an FTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp/{{logging_ftp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"ftp",
"{{logging_ftp_name}}"
]
},
"description": "Update the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"ftp",
"test-log-endpoint"
]
},
"description": "Update the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"21\",\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete an FTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp/{{logging_ftp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"ftp",
"{{logging_ftp_name}}"
]
},
"description": "Delete the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"ftp",
"test-log-endpoint"
]
},
"description": "Delete the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages periodically to the server in the format specified in the FTP object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | An hostname or IPv4 address. |\n| hostname | string | Hostname used. |\n| ipv4 | string | IPv4 address of the host. |\n| password | string | The password for the server. For anonymous use an email address. |\n| path | string | The path to upload log files to. If the path ends in / then it is treated as a directory. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| user | string | The username for the server. Can be anonymous. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "GCS Logging",
"item": [
{
"name": "List GCS log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"gcs"
]
},
"description": "List all of the GCS log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"gcs"
]
},
"description": "List all of the GCS log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}]"
}
]
},
{
"name": "Create a GCS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"gcs"
]
},
"description": "Create GCS logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"gcs"
]
},
"description": "Create GCS logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Get a GCS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs/{{logging_gcs_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"gcs",
"{{logging_gcs_name}}"
]
},
"description": "Get the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"gcs",
"test-log-endpoint"
]
},
"description": "Get the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Update a GCS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs/{{logging_gcs_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"gcs",
"{{logging_gcs_name}}"
]
},
"description": "Update the GCS for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"gcs",
"test-log-endpoint"
]
},
"description": "Update the GCS for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Delete a GCS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs/{{logging_gcs_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"gcs",
"{{logging_gcs_name}}"
]
},
"description": "Delete the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"gcs",
"test-log-endpoint"
]
},
"description": "Delete the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the GCS bucket in the format specified in the GCS object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bucket_name | string | The name of the GCS bucket. |\n| path | string | The path to upload logs to. |\n| project_id | string | Your Google Cloud Platform project ID. Required. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| account_name | string | The name of the Google Cloud Platform service account associated with the target log collection service. Not required if user and secret_key are provided. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified. |\n| timestamp_format | string | A timestamp format. |\n| user | string | Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Not required if account_name is specified. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Google Cloud Pub/Sub Logging",
"item": [
{
"name": "List GCP Cloud Pub/Sub log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"pubsub"
]
},
"description": "List all of the Pub/Sub logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"pubsub"
]
},
"description": "List all of the Pub/Sub logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}]"
}
]
},
{
"name": "Create a GCP Cloud Pub/Sub log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"pubsub"
]
},
"description": "Create a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"pubsub"
]
},
"description": "Create a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Get a GCP Cloud Pub/Sub log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub/{{logging_google_pubsub_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"pubsub",
"{{logging_google_pubsub_name}}"
]
},
"description": "Get the details for a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"pubsub",
"test-log-endpoint"
]
},
"description": "Get the details for a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Update a GCP Cloud Pub/Sub log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub/{{logging_google_pubsub_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"pubsub",
"{{logging_google_pubsub_name}}"
]
},
"description": "Update a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"pubsub",
"test-log-endpoint"
]
},
"description": "Update a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"updated-test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}"
}
]
},
{
"name": "Delete a GCP Cloud Pub/Sub log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub/{{logging_google_pubsub_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"pubsub",
"{{logging_google_pubsub_name}}"
]
},
"description": "Delete a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"pubsub",
"test-log-endpoint"
]
},
"description": "Delete a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will publish log messages to a Google Cloud Pub/Sub topic in the format specified in the Pub/Sub logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| project_id | string | Your Google Cloud Platform project ID. Required. |\n| topic | string | The Google Cloud Pub/Sub topic to which logs will be published. Required. |\n| account_name | string | The name of the Google Cloud Platform service account associated with the target log collection service. Not required if user and secret_key are provided. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Not required if account_name is specified. |\n| user | string | Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Not required if account_name is specified. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Grafana Cloud Logs Logging",
"item": [
{
"name": "List Grafana Cloud Logs log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/grafanacloudlogs",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"grafanacloudlogs"
]
},
"description": "List all of the Grafana Cloud Logs logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/grafanacloudlogs",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"grafanacloudlogs"
]
},
"description": "List all of the Grafana Cloud Logs logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"user\":\"123456\",\"index\":\"{ \\\"app\\\": \\\"test\\\", \\\"env\\\": \\\"staging\\\" }\",\"url\":\"https://testhost-123.grafana.net\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Create a Grafana Cloud Logs log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/grafanacloudlogs",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"grafanacloudlogs"
]
},
"description": "Create a Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/grafanacloudlogs",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"grafanacloudlogs"
]
},
"description": "Create a Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"user\":\"123456\",\"index\":\"{ \\\"app\\\": \\\"test\\\", \\\"env\\\": \\\"staging\\\" }\",\"url\":\"https://testhost-123.grafana.net\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Get a Grafana Cloud Logs log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/grafanacloudlogs/{{logging_grafanacloudlogs_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"grafanacloudlogs",
"{{logging_grafanacloudlogs_name}}"
]
},
"description": "Get the details of a Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/grafanacloudlogs/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"grafanacloudlogs",
"test-log-endpoint"
]
},
"description": "Get the details of a Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"user\":\"123456\",\"index\":\"{ \\\"app\\\": \\\"test\\\", \\\"env\\\": \\\"staging\\\" }\",\"url\":\"https://testhost-123.grafana.net\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Update a Grafana Cloud Logs log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/grafanacloudlogs/{{logging_grafanacloudlogs_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"grafanacloudlogs",
"{{logging_grafanacloudlogs_name}}"
]
},
"description": "Update a Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/grafanacloudlogs/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"grafanacloudlogs",
"test-log-endpoint"
]
},
"description": "Update a Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"user\":\"123456\",\"index\":\"{ \\\"app\\\": \\\"test\\\", \\\"env\\\": \\\"staging\\\" }\",\"url\":\"https://testhost-123.grafana.net\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete the Grafana Cloud Logs log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/grafanacloudlogs/{{logging_grafanacloudlogs_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"grafanacloudlogs",
"{{logging_grafanacloudlogs_name}}"
]
},
"description": "Delete the Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/grafanacloudlogs/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"grafanacloudlogs",
"test-log-endpoint"
]
},
"description": "Delete the Grafana Cloud Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to Grafana Cloud Logs.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| index | string | The Stream Labels, a JSON string used to identify the stream. |\n| token | string | The Grafana Access Policy token with logs:write access scoped to your Loki instance. |\n| url | string | The URL of the Loki instance in your Grafana stack. |\n| user | string | The Grafana Cloud Logs Dataset you want to log to. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Heroku",
"item": [
{
"name": "List Heroku log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"heroku"
]
},
"description": "List all of the Herokus for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"heroku"
]
},
"description": "List all of the Herokus for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}]"
}
]
},
{
"name": "Create a Heroku log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"heroku"
]
},
"description": "Create a Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"heroku"
]
},
"description": "Create a Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}"
}
]
},
{
"name": "Get a Heroku log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku/{{logging_heroku_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"heroku",
"{{logging_heroku_name}}"
]
},
"description": "Get the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"heroku",
"test-log-endpoint"
]
},
"description": "Get the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}"
}
]
},
{
"name": "Update the Heroku log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku/{{logging_heroku_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"heroku",
"{{logging_heroku_name}}"
]
},
"description": "Update the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"heroku",
"test-log-endpoint"
]
},
"description": "Update the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}"
}
]
},
{
"name": "Delete the Heroku log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku/{{logging_heroku_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"heroku",
"{{logging_heroku_name}}"
]
},
"description": "Delete the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"heroku",
"test-log-endpoint"
]
},
"description": "Delete the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will stream log messages to the Heroku account in the format specified in the Heroku object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| token | string | The token to use for authentication (https://devcenter.heroku.com/articles/add-on-partner-log-integration). |\n| url | string | The URL to stream logs to. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Honeycomb Logging",
"item": [
{
"name": "List Honeycomb log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"honeycomb"
]
},
"description": "List all of the Honeycomb logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"honeycomb"
]
},
"description": "List all of the Honeycomb logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Create a Honeycomb log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"honeycomb"
]
},
"description": "Create a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"honeycomb"
]
},
"description": "Create a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Get a Honeycomb log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb/{{logging_honeycomb_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"honeycomb",
"{{logging_honeycomb_name}}"
]
},
"description": "Get the details of a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"honeycomb",
"test-log-endpoint"
]
},
"description": "Get the details of a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Update a Honeycomb log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb/{{logging_honeycomb_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"honeycomb",
"{{logging_honeycomb_name}}"
]
},
"description": "Update a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"honeycomb",
"test-log-endpoint"
]
},
"description": "Update a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":\"2\",\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete the Honeycomb log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb/{{logging_honeycomb_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"honeycomb",
"{{logging_honeycomb_name}}"
]
},
"description": "Delete the Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"honeycomb",
"test-log-endpoint"
]
},
"description": "Delete the Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to Honeycomb.io in the format specified in the Honeycomb object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dataset | string | The Honeycomb Dataset you want to log to. |\n| format | string | A Fastly log format string. Must produce valid JSON that Honeycomb can ingest. |\n| token | string | The Write Key from the Account page of your Honeycomb account. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "HTTPS",
"item": [
{
"name": "List HTTPS log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"https"
]
},
"description": "List all of the HTTPS objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"https"
]
},
"description": "List all of the HTTPS objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"name\":\"test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":\"2\",\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}]"
}
]
},
{
"name": "Create an HTTPS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"https"
]
},
"description": "Create an HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"https"
]
},
"description": "Create an HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":\"2\",\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}"
}
]
},
{
"name": "Get an HTTPS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https/{{logging_https_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"https",
"{{logging_https_name}}"
]
},
"description": "Get the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"https",
"test-log-endpoint"
]
},
"description": "Get the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":\"2\",\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}"
}
]
},
{
"name": "Update an HTTPS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https/{{logging_https_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"https",
"{{logging_https_name}}"
]
},
"description": "Update the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"https",
"test-log-endpoint"
]
},
"description": "Update the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"updated-test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":\"2\",\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n \\\"request\\\":\\\"%{req.request}V\\\",\\n \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}"
}
]
},
{
"name": "Delete an HTTPS log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https/{{logging_https_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"https",
"{{logging_https_name}}"
]
},
"description": "Delete the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"https",
"test-log-endpoint"
]
},
"description": "Delete the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to an HTTPS endpoint in the format specified in the HTTPS object. The HTTPS endpoint requires proof of domain ownership before logs can be received. Learn how to validate your domain in our HTTPS endpoint documentation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| content_type | string | Content type of the header sent with the request. |\n| format | string | A Fastly log format string. |\n| header_name | string | Name of the custom header sent with the request. |\n| header_value | string | Value of the custom header sent with the request. |\n| json_format | string | Enforces valid JSON formatting for log entries. |\n| | 0 | Disabled. |\n| | 1 | Array of JSON. Wraps JSON log batches in an array. |\n| | 2 | Newline delimited JSON. Places each JSON log entry onto a new line in a batch. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| method | string | HTTP method used for request. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 (100MB). |\n| request_max_entries | integer | The maximum number of logs sent in one request. Defaults 0 (10k). |\n| url | string | The URL to send logs to. Must use HTTPS. Required. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Kafka",
"item": [
{
"name": "List Kafka log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kafka"
]
},
"description": "List all of the Kafka logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kafka"
]
},
"description": "List all of the Kafka logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"format_version\":\"2\",\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":\"0\",\"placement\":null,\"version\":\"1\"}]"
}
]
},
{
"name": "Create a Kafka log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kafka"
]
},
"description": "Create a Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kafka"
]
},
"description": "Create a Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format_version\":2,\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":\"0\",\"placement\":null,\"version\":\"1\"}"
}
]
},
{
"name": "Get a Kafka log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka/{{logging_kafka_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kafka",
"{{logging_kafka_name}}"
]
},
"description": "Get the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kafka",
"test-log-endpoint"
]
},
"description": "Get the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format_version\":\"2\",\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":\"0\",\"placement\":null,\"version\":\"1\"}"
}
]
},
{
"name": "Update the Kafka log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka/{{logging_kafka_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kafka",
"{{logging_kafka_name}}"
]
},
"description": "Update the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kafka",
"test-log-endpoint"
]
},
"description": "Update the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format_version\":\"2\",\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":\"0\",\"placement\":null,\"version\":\"1\"}"
}
]
},
{
"name": "Delete the Kafka log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka/{{logging_kafka_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kafka",
"{{logging_kafka_name}}"
]
},
"description": "Delete the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kafka",
"test-log-endpoint"
]
},
"description": "Delete the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages periodically to the server in the format specified in the Kafka object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| auth_method | string | SASL authentication method. |\n| | plain | Use plain user and password authentication. |\n| | scram-sha-256 | Use salted challenge response authentication mechanism with SHA-256 hash function. |\n| | scram-sha-512 | Use salted challenge response authentication mechanism with SHA-512 hash function. |\n| brokers | string | A comma-separated list of IP addresses or hostnames of Kafka brokers. Required. |\n| compression_codec | string | The codec used for compression of your logs. |\n| | gzip | Use gzip compression. |\n| | snappy | Use Snappy compression. |\n| | lz4 | Use LZ4 compression. |\n| | null | |\n| parse_log_keyvals | boolean | Enables parsing of key=value tuples from the beginning of a logline, turning them into record headers. |\n| password | string | SASL password. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 (no limit). |\n| required_acks | integer | The number of acknowledgements a leader must receive before a write is considered successful. |\n| | 1 | One server needs to respond. |\n| | 0 | No servers need to respond. |\n| | -1 | Wait for all in-sync replicas to respond. |\n| topic | string | The Kafka topic to send logs to. Required. |\n| use_tls | string | Whether to use TLS. |\n| | 0 | Do not use TLS. |\n| | 1 | Use TLS. |\n| user | string | SASL user. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Kinesis",
"item": [
{
"name": "List Amazon Kinesis log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kinesis"
]
},
"description": "List all of the Amazon Kinesis Data Streams logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kinesis"
]
},
"description": "List all of the Amazon Kinesis Data Streams logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"iam_role\":null,\"name\":\"test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create an Amazon Kinesis log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kinesis"
]
},
"description": "Create an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kinesis"
]
},
"description": "Create an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"iam_role\":null,\"name\":\"test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Get an Amazon Kinesis log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis/{{logging_kinesis_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kinesis",
"{{logging_kinesis_name}}"
]
},
"description": "Get the details for an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kinesis",
"test-log-endpoint"
]
},
"description": "Get the details for an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"iam_role\":null,\"name\":\"test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Update the Amazon Kinesis log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis/{{logging_kinesis_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kinesis",
"{{logging_kinesis_name}}"
]
},
"description": "Update an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kinesis",
"test-log-endpoint"
]
},
"description": "Update an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"iam_role\":null,\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete the Amazon Kinesis log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis/{{logging_kinesis_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"kinesis",
"{{logging_kinesis_name}}"
]
},
"description": "Delete an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"kinesis",
"test-log-endpoint"
]
},
"description": "Delete an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will publish log messages to an Amazon Kinesis stream in the format specified in the Amazon Kinesis Data Streams logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | The access key associated with the target Amazon Kinesis stream. Not required if iam_role is specified. |\n| format | string | A Fastly log format string. |\n| iam_role | string | The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if access_key and secret_key are provided. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| region | string | A named set of AWS resources that's in the same geographical area. |\n| secret_key | string | The secret key associated with the target Amazon Kinesis stream. Not required if iam_role is specified. |\n| topic | string | The Amazon Kinesis stream to send logs to. Required. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Loggly",
"item": [
{
"name": "List Loggly log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"loggly"
]
},
"description": "List all Loggly logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"loggly"
]
},
"description": "List all Loggly logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"token\":\"test-token\",\"placement\":null}]"
}
]
},
{
"name": "Create a Loggly log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"loggly"
]
},
"description": "Create a Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"loggly"
]
},
"description": "Create a Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"token\":\"test-token\",\"placement\":null}"
}
]
},
{
"name": "Get a Loggly log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly/{{logging_loggly_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"loggly",
"{{logging_loggly_name}}"
]
},
"description": "Get the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"loggly",
"test-log-endpoint"
]
},
"description": "Get the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"token\":\"test-token\",\"placement\":null}"
}
]
},
{
"name": "Update a Loggly log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly/{{logging_loggly_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"loggly",
"{{logging_loggly_name}}"
]
},
"description": "Update the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"loggly",
"test-log-endpoint"
]
},
"description": "Update the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"token\":\"test-token\",\"placement\":null}"
}
]
},
{
"name": "Delete a Loggly log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly/{{logging_loggly_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"loggly",
"{{logging_loggly_name}}"
]
},
"description": "Delete the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"loggly",
"test-log-endpoint"
]
},
"description": "Delete the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will stream log messages to the Loggly account in the format specified in the Loggly logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| token | string | The token to use for authentication (https://www.loggly.com/docs/customer-token-authentication-token/). |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Log Shuttle",
"item": [
{
"name": "List Log Shuttle log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"logshuttle"
]
},
"description": "List all of the Log Shuttle logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"logshuttle"
]
},
"description": "List all of the Log Shuttle logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create a Log Shuttle log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"logshuttle"
]
},
"description": "Create a Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"logshuttle"
]
},
"description": "Create a Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":\"1\"}"
}
]
},
{
"name": "Get a Log Shuttle log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle/{{logging_logshuttle_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"logshuttle",
"{{logging_logshuttle_name}}"
]
},
"description": "Get the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"logshuttle",
"test-log-endpoint"
]
},
"description": "Get the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":\"1\"}"
}
]
},
{
"name": "Update a Log Shuttle log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle/{{logging_logshuttle_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"logshuttle",
"{{logging_logshuttle_name}}"
]
},
"description": "Update the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"logshuttle",
"test-log-endpoint"
]
},
"description": "Update the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete a Log Shuttle log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle/{{logging_logshuttle_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"logshuttle",
"{{logging_logshuttle_name}}"
]
},
"description": "Delete the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"logshuttle",
"test-log-endpoint"
]
},
"description": "Delete the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the Log Shuttle bucket in the format specified in the logshuttle object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| token | string | The data authentication token associated with this endpoint. |\n| url | string | The URL to stream logs to. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "New Relic Logs",
"item": [
{
"name": "List New Relic log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelic"
]
},
"description": "List all of the New Relic Logs logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelic"
]
},
"description": "List all of the New Relic Logs logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}]"
}
]
},
{
"name": "Create a New Relic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelic"
]
},
"description": "Create a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelic"
]
},
"description": "Create a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}"
}
]
},
{
"name": "Get a New Relic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic/{{logging_newrelic_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelic",
"{{logging_newrelic_name}}"
]
},
"description": "Get the details of a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelic",
"test-log-endpoint"
]
},
"description": "Get the details of a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}"
}
]
},
{
"name": "Update a New Relic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic/{{logging_newrelic_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelic",
"{{logging_newrelic_name}}"
]
},
"description": "Update a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelic",
"test-log-endpoint"
]
},
"description": "Update a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}"
}
]
},
{
"name": "Delete a New Relic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic/{{logging_newrelic_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelic",
"{{logging_newrelic_name}}"
]
},
"description": "Delete the New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelic",
"test-log-endpoint"
]
},
"description": "Delete the New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to New Relic Logs in the format specified in the New Relic configuration object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. Must produce valid JSON that New Relic Logs can ingest. |\n| region | string | The region to which to stream logs. |\n| token | string | The Insert API key from the Account page of your New Relic account. Required. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "New Relic OTLP",
"item": [
{
"name": "List New Relic OTLP endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelicotlp",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelicotlp"
]
},
"description": "List all of the New Relic OTLP logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelicotlp",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelicotlp"
]
},
"description": "List all of the New Relic OTLP logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\",\"url\":null}]"
}
]
},
{
"name": "Create a New Relic OTLP endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelicotlp",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelicotlp"
]
},
"description": "Create a New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelicotlp",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelicotlp"
]
},
"description": "Create a New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\",\"url\":null}"
}
]
},
{
"name": "Get a New Relic OTLP endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelicotlp/{{logging_newrelicotlp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelicotlp",
"{{logging_newrelicotlp_name}}"
]
},
"description": "Get the details of a New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelicotlp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelicotlp",
"test-log-endpoint"
]
},
"description": "Get the details of a New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\",\"url\":null}"
}
]
},
{
"name": "Update a New Relic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelicotlp/{{logging_newrelicotlp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelicotlp",
"{{logging_newrelicotlp_name}}"
]
},
"description": "Update a New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelicotlp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelicotlp",
"test-log-endpoint"
]
},
"description": "Update a New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":\"2\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\",\"url\":null}"
}
]
},
{
"name": "Delete a New Relic OTLP endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelicotlp/{{logging_newrelicotlp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"newrelicotlp",
"{{logging_newrelicotlp_name}}"
]
},
"description": "Delete the New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelicotlp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"newrelicotlp",
"test-log-endpoint"
]
},
"description": "Delete the New Relic OTLP logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Allows OTLP trace data to be sent to New Relic. Requires custom VCL to instrument the service to generate OTLP trace data. See https://docs.fastly.com/en/guides/log-streaming-newrelic-otlp#instrumenting-your-vcl-service for details.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| region | string | The region to which to stream logs. |\n| token | string | The Insert API key from the Account page of your New Relic account. Required. |\n| url | string | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "OpenStack",
"item": [
{
"name": "List OpenStack log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"openstack"
]
},
"description": "List all of the openstacks for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"openstack"
]
},
"description": "List all of the openstacks for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":\"\",\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create an OpenStack log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"openstack"
]
},
"description": "Create a openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"openstack"
]
},
"description": "Create a openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":\"\",\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":\"1\"}"
}
]
},
{
"name": "Get an OpenStack log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack/{{logging_openstack_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"openstack",
"{{logging_openstack_name}}"
]
},
"description": "Get the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"openstack",
"test-log-endpoint"
]
},
"description": "Get the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":\"\",\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":\"1\"}"
}
]
},
{
"name": "Update an OpenStack log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack/{{logging_openstack_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"openstack",
"{{logging_openstack_name}}"
]
},
"description": "Update the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"openstack",
"test-log-endpoint"
]
},
"description": "Update the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"path\":\"\",\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete an OpenStack log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack/{{logging_openstack_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"openstack",
"{{logging_openstack_name}}"
]
},
"description": "Delete the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"openstack",
"test-log-endpoint"
]
},
"description": "Delete the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the OpenStack bucket in the format specified in the openstack object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | Your OpenStack account access key. |\n| bucket_name | string | The name of your OpenStack container. |\n| path | string | The path to upload logs to. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| url | string | Your OpenStack auth url. |\n| user | string | The username for your OpenStack account. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Papertrail",
"item": [
{
"name": "List Papertrail log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"papertrail"
]
},
"description": "List all of the Papertrails for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"papertrail"
]
},
"description": "List all of the Papertrails for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create a Papertrail log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"papertrail"
]
},
"description": "Create a Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"papertrail"
]
},
"description": "Create a Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Get a Papertrail log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail/{{logging_papertrail_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"papertrail",
"{{logging_papertrail_name}}"
]
},
"description": "Get the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"papertrail",
"test-log-endpoint"
]
},
"description": "Get the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Update a Papertrail log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail/{{logging_papertrail_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"papertrail",
"{{logging_papertrail_name}}"
]
},
"description": "Update the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"papertrail",
"test-log-endpoint"
]
},
"description": "Update the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete a Papertrail log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail/{{logging_papertrail_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"papertrail",
"{{logging_papertrail_name}}"
]
},
"description": "Delete the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"papertrail",
"test-log-endpoint"
]
},
"description": "Delete the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will stream log messages to the Papertrail account in the format specified in the Papertrail object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | A hostname or IPv4 address. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "S3",
"item": [
{
"name": "List AWS S3 log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"s3"
]
},
"description": "List all of the S3s for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"s3"
]
},
"description": "List all of the S3s for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\",\"file_max_bytes\":100000000}]"
}
]
},
{
"name": "Create an AWS S3 log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"s3"
]
},
"description": "Create a S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"s3"
]
},
"description": "Create a S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\",\"file_max_bytes\":100000000}"
}
]
},
{
"name": "Get an AWS S3 log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3/{{logging_s3_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"s3",
"{{logging_s3_name}}"
]
},
"description": "Get the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"s3",
"test-log-endpoint"
]
},
"description": "Get the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\",\"file_max_bytes\":100000000}"
}
]
},
{
"name": "Update an AWS S3 log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3/{{logging_s3_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"s3",
"{{logging_s3_name}}"
]
},
"description": "Update the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"s3",
"test-log-endpoint"
]
},
"description": "Update the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":\"0\",\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"path\":null,\"period\":\"3600\",\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":\"1\",\"file_max_bytes\":100000000}"
}
]
},
{
"name": "Delete an AWS S3 log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3/{{logging_s3_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"s3",
"{{logging_s3_name}}"
]
},
"description": "Delete the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"s3",
"test-log-endpoint"
]
},
"description": "Delete the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages to the S3 bucket in the format specified in the S3 object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | The access key for your S3 account. Not required if iam_role is provided. |\n| acl | string | The access control list (ACL) specific request header. See the AWS documentation for Access Control List (ACL) Specific Request Headers for more information. |\n| bucket_name | string | The bucket name for S3 account. |\n| domain | string | The domain of the Amazon S3 endpoint. |\n| file_max_bytes | integer | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.). |\n| iam_role | string | The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if access_key and secret_key are provided. |\n| path | string | The path to upload logs to. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| redundancy | string | The S3 redundancy level. |\n| secret_key | string | The secret key for your S3 account. Not required if iam_role is provided. |\n| server_side_encryption | string | Set this to AES256 or aws:kms to enable S3 Server Side Encryption. |\n| server_side_encryption_kms_key_id | string | Optional server-side KMS Key Id. Must be set if server_side_encryption is set to aws:kms or AES256. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Scalyr",
"item": [
{
"name": "List Scalyr log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"scalyr"
]
},
"description": "List all of the Scalyrs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"scalyr"
]
},
"description": "List all of the Scalyrs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}]"
}
]
},
{
"name": "Create a Scalyr log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"scalyr"
]
},
"description": "Create a Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"scalyr"
]
},
"description": "Create a Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}"
}
]
},
{
"name": "Get a Scalyr log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr/{{logging_scalyr_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"scalyr",
"{{logging_scalyr_name}}"
]
},
"description": "Get the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"scalyr",
"test-log-endpoint"
]
},
"description": "Get the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}"
}
]
},
{
"name": "Update the Scalyr log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr/{{logging_scalyr_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"scalyr",
"{{logging_scalyr_name}}"
]
},
"description": "Update the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"scalyr",
"test-log-endpoint"
]
},
"description": "Update the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":\"1\",\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}"
}
]
},
{
"name": "Delete the Scalyr log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr/{{logging_scalyr_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"scalyr",
"{{logging_scalyr_name}}"
]
},
"description": "Delete the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"scalyr",
"test-log-endpoint"
]
},
"description": "Delete the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will stream log messages to the Scalyr account in the format specified in the Scalyr object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| project_id | string | The name of the logfile within Scalyr. |\n| region | string | The region that log data will be sent to. |\n| token | string | The token to use for authentication. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "SFTP",
"item": [
{
"name": "List SFTP log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sftp"
]
},
"description": "List all of the SFTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sftp"
]
},
"description": "List all of the SFTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"22\",\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create an SFTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sftp"
]
},
"description": "Create a SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sftp"
]
},
"description": "Create a SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"22\",\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}"
}
]
},
{
"name": "Get an SFTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp/{{logging_sftp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sftp",
"{{logging_sftp_name}}"
]
},
"description": "Get the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sftp",
"test-log-endpoint"
]
},
"description": "Get the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"22\",\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}"
}
]
},
{
"name": "Update an SFTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp/{{logging_sftp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sftp",
"{{logging_sftp_name}}"
]
},
"description": "Update the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sftp",
"test-log-endpoint"
]
},
"description": "Update the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":\"3600\",\"placement\":null,\"port\":\"22\",\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete an SFTP log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp/{{logging_sftp_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sftp",
"{{logging_sftp_name}}"
]
},
"description": "Delete the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sftp",
"test-log-endpoint"
]
},
"description": "Delete the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will upload log messages periodically to the server in the format specified in the SFTP object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| password | string | The password for the server. If both password and secret_key are passed, secret_key will be used in preference. |\n| path | string | The path to upload logs to. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| secret_key | string | The SSH private key for the server. If both password and secret_key are passed, secret_key will be used in preference. |\n| ssh_known_hosts | string | A list of host keys for all hosts we can connect to over SFTP. |\n| user | string | The username for the server. |\n| address | string | A hostname or IPv4 address. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Splunk",
"item": [
{
"name": "List Splunk log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"splunk"
]
},
"description": "List all of the Splunk logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"splunk"
]
},
"description": "List all of the Splunk logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"format_version\":\"2\",\"token\":\"test-token\",\"use_tls\":\"0\"}]"
}
]
},
{
"name": "Create a Splunk log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"splunk"
]
},
"description": "Create a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"splunk"
]
},
"description": "Create a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"format_version\":\"2\",\"token\":\"test-token\",\"use_tls\":\"0\"}"
}
]
},
{
"name": "Get a Splunk log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk/{{logging_splunk_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"splunk",
"{{logging_splunk_name}}"
]
},
"description": "Get the details for a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"splunk",
"test-log-endpoint"
]
},
"description": "Get the details for a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"format_version\":\"2\",\"token\":\"test-token\",\"use_tls\":\"0\"}"
}
]
},
{
"name": "Update a Splunk log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk/{{logging_splunk_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"splunk",
"{{logging_splunk_name}}"
]
},
"description": "Update the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"splunk",
"test-log-endpoint"
]
},
"description": "Update the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":\"1\",\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"updated-test-log-endpoint\",\"format_version\":\"2\",\"token\":\"test-token\",\"use_tls\":\"0\"}"
}
]
},
{
"name": "Delete a Splunk log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk/{{logging_splunk_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"splunk",
"{{logging_splunk_name}}"
]
},
"description": "Delete the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"splunk",
"test-log-endpoint"
]
},
"description": "Delete the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will POST messages to your Splunk account in the format specified in the Splunk object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| token | string | A Splunk token for use in posting logs over HTTP to your collector. |\n| url | string | The URL to post logs to. |\n| use_tls | string | Whether to use TLS. |\n| | 0 | Do not use TLS. |\n| | 1 | Use TLS. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 for unbounded. |\n| request_max_entries | integer | The maximum number of logs sent in one request. Defaults 0 for unbounded. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Sumologic",
"item": [
{
"name": "List Sumologic log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sumologic"
]
},
"description": "List all of the Sumologics for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sumologic"
]
},
"description": "List all of the Sumologics for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create a Sumologic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sumologic"
]
},
"description": "Create a Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sumologic"
]
},
"description": "Create a Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":\"1\"}"
}
]
},
{
"name": "Get a Sumologic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic/{{logging_sumologic_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sumologic",
"{{logging_sumologic_name}}"
]
},
"description": "Get the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sumologic",
"test-log-endpoint"
]
},
"description": "Get the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":\"1\"}"
}
]
},
{
"name": "Update a Sumologic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic/{{logging_sumologic_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sumologic",
"{{logging_sumologic_name}}"
]
},
"description": "Update the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sumologic",
"test-log-endpoint"
]
},
"description": "Update the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete a Sumologic log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic/{{logging_sumologic_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"sumologic",
"{{logging_sumologic_name}}"
]
},
"description": "Delete the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"sumologic",
"test-log-endpoint"
]
},
"description": "Delete the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will POST messages to the Sumo Logic account in the format specified in the Sumologic object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| url | string | The URL to post logs to. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Syslog",
"item": [
{
"name": "List Syslog log endpoints",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"syslog"
]
},
"description": "List all of the Syslogs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"syslog"
]
},
"description": "List all of the Syslogs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":\"0\",\"version\":\"1\"}]"
}
]
},
{
"name": "Create a syslog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"syslog"
]
},
"description": "Create a Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"syslog"
]
},
"description": "Create a Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":\"0\",\"version\":\"1\"}"
}
]
},
{
"name": "Get a syslog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog/{{logging_syslog_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"syslog",
"{{logging_syslog_name}}"
]
},
"description": "Get the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"syslog",
"test-log-endpoint"
]
},
"description": "Get the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":\"0\",\"version\":\"1\"}"
}
]
},
{
"name": "Update a syslog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog/{{logging_syslog_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"syslog",
"{{logging_syslog_name}}"
]
},
"description": "Update the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"syslog",
"test-log-endpoint"
]
},
"description": "Update the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":\"2\",\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":\"0\",\"version\":\"1\"}"
}
]
},
{
"name": "Delete a syslog log endpoint",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog/{{logging_syslog_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"logging",
"syslog",
"{{logging_syslog_name}}"
]
},
"description": "Delete the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog/test-log-endpoint",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"logging",
"syslog",
"test-log-endpoint"
]
},
"description": "Delete the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Fastly will stream log messages to the location in the format specified in the Syslog object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| hostname | string | The hostname used for the syslog endpoint. |\n| ipv4 | string | The IPv4 address used for the syslog endpoint. |\n| message_type | string | How the message should be formatted. |\n| | classic | RFC 3164 syslog prefix. |\n| | loggly | RFC 5424 structured syslog. |\n| | logplex | Heroku-style length prefixed syslog. |\n| | blank | No prefix. Useful for writing JSON and CSV. |\n| token | string | Whether to prepend each message with a specific token. |\n| use_tls | string | Whether to use TLS. |\n| | 0 | Do not use TLS. |\n| | 1 | Use TLS. |\n| address | string | A hostname or IPv4 address. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n| | 1 | Version 1 log format. |\n| | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n| | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n| | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | string | String identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Domain metrics",
"item": [
{
"name": "Domain Inspector Historical API",
"item": [
{
"name": "Get historical domain data for a service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/metrics/domains/services/{{service_id}}?cursor&datacenter&domain&downsample&end&group_by&limit&metric®ion&start",
"host": [
"{{fastly_url}}"
],
"path": [
"metrics",
"domains",
"services",
"{{service_id}}"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "datacenter",
"description": "Limit query to one or more specific POPs. Values should be comma-separated."
},
{
"key": "domain",
"description": "Limit query to one or more specific domains. Values should be comma-separated."
},
{
"key": "downsample",
"description": "Duration of sample windows."
},
{
"key": "end",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."
},
{
"key": "group_by",
"description": "Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=domain will return one timeseries for every domain, as a total across all datacenters (POPs)."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 200."
},
{
"key": "metric",
"description": "The metrics to retrieve. Multiple values should be comma-separated."
},
{
"key": "region",
"description": "Limit query to one or more specific geographic regions. Values should be comma-separated."
},
{
"key": "start",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."
}
]
},
"description": "Fetches historical domain metrics for a given Fastly service, optionally filtering and grouping the results by domain, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/metrics/domains/services/SU1Z0isxPaozGVKXdv0eY?datacenter=SJC%2CSTP&domain=domain_1.com%2Cdomain_2.com&downsample=hour&end=2020-08-02T00%3A00%3A00.000Z&group_by=domain&metric=resp_body_bytes%2Cstatus_2xx®ion=usa&start=2021-08-01T00%3A00%3A00.000Z?cursor&datacenter&domain&downsample&end&group_by&limit&metric®ion&start",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"metrics",
"domains",
"services",
"SU1Z0isxPaozGVKXdv0eY"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "datacenter",
"description": "Limit query to one or more specific POPs. Values should be comma-separated."
},
{
"key": "domain",
"description": "Limit query to one or more specific domains. Values should be comma-separated."
},
{
"key": "downsample",
"description": "Duration of sample windows."
},
{
"key": "end",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."
},
{
"key": "group_by",
"description": "Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=domain will return one timeseries for every domain, as a total across all datacenters (POPs)."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 200."
},
{
"key": "metric",
"description": "The metrics to retrieve. Multiple values should be comma-separated."
},
{
"key": "region",
"description": "Limit query to one or more specific geographic regions. Values should be comma-separated."
},
{
"key": "start",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."
}
]
},
"description": "Fetches historical domain metrics for a given Fastly service, optionally filtering and grouping the results by domain, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"dimensions\":{\"domain\":\"domain1.com\",\"region\":\"usa\",\"datacenter\":\"SJC\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":552256,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":12323,\"status_2xx\":34}]},{\"dimensions\":{\"domain\":\"sub.domain2.com\",\"region\":\"usa\",\"datacenter\":\"STP\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":221,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":234,\"status_2xx\":34}]}],\"meta\":{\"start\":\"2021-08-01T00:00:00Z\",\"end\":\"2020-08-02T00:00:00Z\",\"downsample\":\"hour\",\"metric\":\"resp_body_bytes,status_2xx\",\"limit\":100,\"next_cursor\":\"VTBwRENqVTJXVmszUz\",\"sort\":\"domain,region,datacenter\",\"group_by\":\"none\",\"filters\":{}},\"status\":\"success\"}"
}
]
}
],
"description": "Domain Inspector provides a JSON-formatted historical API for visibility into responses delivered from your domains by Fastly. The API offers a standardized set of data to report in minutely, hourly, or daily granularity on every domain response, byte, and status code received by a specified service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| datacenter | string | The POP from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across POPs. |\n| domain | string | The domain from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across domains. |\n| region | string | The geographic region from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across regions. |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| meta | object | Meta information about the scope of the query in a human readable format. |\n| msg | string | If the query was not successful, this will provide a string that explains why. |\n| status | string | Whether or not we were able to successfully execute the query. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bandwidth | integer | Total bytes delivered (resp_header_bytes + resp_body_bytes + bereq_header_bytes + bereq_body_bytes). |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| edge_hit_ratio | number | Ratio of cache hits to cache misses at the edge, between 0 and 1 (edge_hit_requests / (edge_hit_requests + edge_miss_requests)). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | number | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((edge_resp_body_bytes + edge_resp_header_bytes) - (origin_fetch_resp_body_bytes + origin_fetch_resp_header_bytes)) / (edge_resp_body_bytes + edge_resp_header_bytes). Previously, Origin Offload used a different formula. Learn more. |\n| origin_status_1xx | integer | Number of \"Informational\" category status codes received from origin. |\n| origin_status_200 | integer | Number of responses received from origin with status code 200 (Success). |\n| origin_status_204 | integer | Number of responses received from origin with status code 204 (No Content). |\n| origin_status_206 | integer | Number of responses received from origin with status code 206 (Partial Content). |\n| origin_status_2xx | integer | Number of \"Success\" status codes received from origin. |\n| origin_status_301 | integer | Number of responses received from origin with status code 301 (Moved Permanently). |\n| origin_status_302 | integer | Number of responses received from origin with status code 302 (Found). |\n| origin_status_304 | integer | Number of responses received from origin with status code 304 (Not Modified). |\n| origin_status_3xx | integer | Number of \"Redirection\" codes received from origin. |\n| origin_status_400 | integer | Number of responses received from origin with status code 400 (Bad Request). |\n| origin_status_401 | integer | Number of responses received from origin with status code 401 (Unauthorized). |\n| origin_status_403 | integer | Number of responses received from origin with status code 403 (Forbidden). |\n| origin_status_404 | integer | Number of responses received from origin with status code 404 (Not Found). |\n| origin_status_416 | integer | Number of responses received from origin with status code 416 (Range Not Satisfiable). |\n| origin_status_429 | integer | Number of responses received from origin with status code 429 (Too Many Requests). |\n| origin_status_4xx | integer | Number of \"Client Error\" codes received from origin. |\n| origin_status_500 | integer | Number of responses received from origin with status code 500 (Internal Server Error). |\n| origin_status_501 | integer | Number of responses received from origin with status code 501 (Not Implemented). |\n| origin_status_502 | integer | Number of responses received from origin with status code 502 (Bad Gateway). |\n| origin_status_503 | integer | Number of responses received from origin with status code 503 (Service Unavailable). |\n| origin_status_504 | integer | Number of responses received from origin with status code 504 (Gateway Timeout). |\n| origin_status_505 | integer | Number of responses received from origin with status code 505 (HTTP Version Not Supported). |\n| origin_status_530 | integer | Number of responses received from origin with status code 530. |\n| origin_status_5xx | integer | Number of \"Server Error\" codes received from origin. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered. |\n| resp_header_bytes | integer | Total header bytes delivered. |\n| status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses delivered with status code 200 (Success). |\n| status_204 | integer | Number of responses delivered with status code 204 (No Content). |\n| status_206 | integer | Number of responses delivered with status code 206 (Partial Content). |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses delivered with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses delivered with status code 302 (Found). |\n| status_304 | integer | Number of responses delivered with status code 304 (Not Modified). |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses delivered with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses delivered with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses delivered with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses delivered with status code 404 (Not Found). |\n| status_416 | integer | Number of responses delivered with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses delivered with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses delivered with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses delivered with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses delivered with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses delivered with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses delivered with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses delivered with status code 505 (HTTP Version Not Supported). |\n| status_530 | integer | Number of responses delivered with status code 530. |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Domain Inspector Real-time API",
"item": [
{
"name": "Get real-time domain data from a specified time",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/domains/{{service_id}}/ts/{{start_timestamp}}",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"domains",
"{{service_id}}",
"ts",
"{{start_timestamp}}"
]
},
"description": "Get real-time domain data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/domains/SU1Z0isxPaozGVKXdv0eY/ts/1608560817",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"domains",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"1608560817"
]
},
"description": "Get real-time domain data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"STP\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}"
}
]
},
{
"name": "Get real-time domain data for the last 120 seconds",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/domains/{{service_id}}/ts/h",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"domains",
"{{service_id}}",
"ts",
"h"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/domains/SU1Z0isxPaozGVKXdv0eY/ts/h",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"domains",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"h"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"STP\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}"
}
]
},
{
"name": "Get a limited number of real-time domain data entries",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/domains/{{service_id}}/ts/h/limit/{{max_entries}}",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"domains",
"{{service_id}}",
"ts",
"h",
"limit",
"{{max_entries}}"
]
},
"description": "Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/domains/SU1Z0isxPaozGVKXdv0eY/ts/h/limit/1",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"domains",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"h",
"limit",
"1"
]
},
"description": "Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"STP\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}"
}
]
}
],
"description": "The real-time domain metrics API allows you to programmatically retrieve per-domain delivery metrics derived from your Fastly services in one-second periods up to the last complete second.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| AggregateDelay | integer | Offset of entry timestamps from the current time due to processing time. |\n| Data | array | A list of report entries, each representing one second of time. |\n| Timestamp | integer | Value to use for subsequent requests. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bandwidth | integer | Total bytes delivered (resp_header_bytes + resp_body_bytes + bereq_header_bytes + bereq_body_bytes). |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| edge_hit_ratio | number | Ratio of cache hits to cache misses at the edge, between 0 and 1 (edge_hit_requests / (edge_hit_requests + edge_miss_requests)). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | number | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((edge_resp_body_bytes + edge_resp_header_bytes) - (origin_fetch_resp_body_bytes + origin_fetch_resp_header_bytes)) / (edge_resp_body_bytes + edge_resp_header_bytes). Previously, Origin Offload used a different formula. Learn more. |\n| origin_status_1xx | integer | Number of \"Informational\" category status codes received from origin. |\n| origin_status_200 | integer | Number of responses received from origin with status code 200 (Success). |\n| origin_status_204 | integer | Number of responses received from origin with status code 204 (No Content). |\n| origin_status_206 | integer | Number of responses received from origin with status code 206 (Partial Content). |\n| origin_status_2xx | integer | Number of \"Success\" status codes received from origin. |\n| origin_status_301 | integer | Number of responses received from origin with status code 301 (Moved Permanently). |\n| origin_status_302 | integer | Number of responses received from origin with status code 302 (Found). |\n| origin_status_304 | integer | Number of responses received from origin with status code 304 (Not Modified). |\n| origin_status_3xx | integer | Number of \"Redirection\" codes received from origin. |\n| origin_status_400 | integer | Number of responses received from origin with status code 400 (Bad Request). |\n| origin_status_401 | integer | Number of responses received from origin with status code 401 (Unauthorized). |\n| origin_status_403 | integer | Number of responses received from origin with status code 403 (Forbidden). |\n| origin_status_404 | integer | Number of responses received from origin with status code 404 (Not Found). |\n| origin_status_416 | integer | Number of responses received from origin with status code 416 (Range Not Satisfiable). |\n| origin_status_429 | integer | Number of responses received from origin with status code 429 (Too Many Requests). |\n| origin_status_4xx | integer | Number of \"Client Error\" codes received from origin. |\n| origin_status_500 | integer | Number of responses received from origin with status code 500 (Internal Server Error). |\n| origin_status_501 | integer | Number of responses received from origin with status code 501 (Not Implemented). |\n| origin_status_502 | integer | Number of responses received from origin with status code 502 (Bad Gateway). |\n| origin_status_503 | integer | Number of responses received from origin with status code 503 (Service Unavailable). |\n| origin_status_504 | integer | Number of responses received from origin with status code 504 (Gateway Timeout). |\n| origin_status_505 | integer | Number of responses received from origin with status code 505 (HTTP Version Not Supported). |\n| origin_status_530 | integer | Number of responses received from origin with status code 530. |\n| origin_status_5xx | integer | Number of \"Server Error\" codes received from origin. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered. |\n| resp_header_bytes | integer | Total header bytes delivered. |\n| status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses delivered with status code 200 (Success). |\n| status_204 | integer | Number of responses delivered with status code 204 (No Content). |\n| status_206 | integer | Number of responses delivered with status code 206 (Partial Content). |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses delivered with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses delivered with status code 302 (Found). |\n| status_304 | integer | Number of responses delivered with status code 304 (Not Modified). |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses delivered with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses delivered with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses delivered with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses delivered with status code 404 (Not Found). |\n| status_416 | integer | Number of responses delivered with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses delivered with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses delivered with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses delivered with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses delivered with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses delivered with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses delivered with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses delivered with status code 505 (HTTP Version Not Supported). |\n| status_530 | integer | Number of responses delivered with status code 530. |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aggregated | object | Groups measurements by backend name and then by IP address. |\n| datacenter | object | Groups measurements by POP, then backend name, and then IP address. See the POPs API for details about POP identifiers. |\n| recorded | integer | The Unix timestamp at which this record's data was generated. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Metrics and stats",
"item": [
{
"name": "Historical Stats",
"item": [
{
"name": "Get historical stats",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats?by&from®ion&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches historical stats for each of your Fastly services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats?by=day&from=2020-04-09T18%3A14%3A30Z®ion=usa&to=2020-04-09T18%3A14%3A30Z?by&from®ion&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches historical stats for each of your Fastly services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:08:35 UTC 2020\",\"from\":\"Tue May 14 20:08:35 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"6ElZZvtumbwtLBDJvFwepx\":[{\"requests\":1925645,\"miss_time\":55.153864891000005,\"start_time\":1368662400,\"service_id\":\"6ElZZvtumbwtLBDJvFwepx\",\"bandwidth\":176544526854,\"hits\":1902348,\"hits_time\":520.0779119150006,\"miss\":8354,\"body_size\":175900019026,\"pass\":4212,\"header_size\":644507828,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":644507828,\"resp_body_bytes\":175900019026,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":1208426,\"status_204\":0,\"status_301\":0,\"status_302\":0,\"status_304\":0,\"errors\":8418,\"hit_ratio\":0.9956,\"status_1xx\":0,\"status_2xx\":1208426,\"status_3xx\":0,\"status_4xx\":708801,\"status_503\":8418,\"pipe\":0,\"status_5xx\":8418,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}],\"5oYej0l0heMydtjaVPOq4z\":[{\"requests\":751,\"miss_time\":1.198163271,\"start_time\":1368662400,\"service_id\":\"5oYej0l0heMydtjaVPOq4z\",\"bandwidth\":1159652,\"hits\":743,\"hits_time\":0.07059622299999999,\"miss\":8,\"body_size\":721082,\"pass\":0,\"header_size\":438570,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":438570,\"resp_body_bytes\":721082,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":580,\"status_204\":0,\"status_301\":2,\"status_302\":0,\"status_304\":169,\"errors\":0,\"hit_ratio\":0.9893,\"status_1xx\":0,\"status_2xx\":580,\"status_3xx\":171,\"status_4xx\":0,\"status_503\":0,\"pipe\":0,\"status_5xx\":0,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}]}}"
}
]
},
{
"name": "Get historical stats for a single field",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/field/{{field}}?by&from®ion&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"field",
"{{field}}"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches the specified field from the historical stats for each of your services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/field/hit_ratio?by=day&from=2020-04-09T18%3A14%3A30Z®ion=usa&to=2020-04-09T18%3A14%3A30Z?by&from®ion&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"field",
"hit_ratio"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches the specified field from the historical stats for each of your services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 17:13:03 UTC 2020\",\"from\":\"Thu May 14 17:13:03 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"6ElZZvtumbwtLBDJvFwepx\":[{\"service_id\":\"6ElZZvtumbwtLBDJvFwepx\",\"start_time\":1368720000,\"hit_ratio\":0.9769},{\"service_id\":\"6ElZZvtumbwtLBDJvFwepx\",\"start_time\":1368723600,\"hit_ratio\":0.9944}],\"5oYej0l0heMydtjaVPOq4z\":[{\"service_id\":\"5oYej0l0heMydtjaVPOq4z\",\"start_time\":1368716400,\"hit_ratio\":0.9857},{\"service_id\":\"5oYej0l0heMydtjaVPOq4z\",\"start_time\":1368723600,\"hit_ratio\":1}]}}"
}
]
},
{
"name": "Get aggregated historical stats",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/aggregate?by&from®ion&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"aggregate"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches historical stats information aggregated across all of your Fastly services.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/aggregate?by=day&from=2020-04-09T18%3A14%3A30Z®ion=usa&to=2020-04-09T18%3A14%3A30Z?by&from®ion&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"aggregate"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches historical stats information aggregated across all of your Fastly services.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:29:37 UTC 2020\",\"from\":\"Tue May 14 20:29:37 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[{\"requests\":7022557,\"miss_time\":43342.54711368301,\"start_time\":1368576000,\"bandwidth\":33656143431,\"hits\":1851903,\"hits_time\":284.90881923000006,\"miss\":74773,\"body_size\":31118762171,\"pass\":5076669,\"header_size\":2537381260,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":2537381260,\"resp_body_bytes\":31118762171,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":6959769,\"status_204\":0,\"status_301\":3093,\"status_302\":60,\"status_304\":14135,\"errors\":21642,\"hit_ratio\":0.9612,\"status_1xx\":0,\"status_2xx\":6959769,\"status_3xx\":17288,\"status_4xx\":23855,\"status_503\":21631,\"pipe\":0,\"status_5xx\":21642,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404},{\"requests\":7908607,\"miss_time\":31645.078110511986,\"start_time\":1368662400,\"bandwidth\":201478840738,\"hits\":3455867,\"hits_time\":751.2703607920007,\"miss\":114580,\"body_size\":198672905955,\"pass\":4310192,\"header_size\":2805934783,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":2805934783,\"resp_body_bytes\":198672905955,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":7128395,\"status_204\":0,\"status_301\":2649,\"status_302\":30,\"status_304\":9920,\"errors\":41389,\"hit_ratio\":0.9679,\"status_1xx\":0,\"status_2xx\":7128395,\"status_3xx\":12599,\"status_4xx\":726224,\"status_503\":41246,\"pipe\":0,\"status_5xx\":41389,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}]}"
}
]
},
{
"name": "Get historical stats for a single service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/service/{{service_id}}?by&from®ion&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"service",
"{{service_id}}"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/service/SU1Z0isxPaozGVKXdv0eY?by=day&from=2020-04-09T18%3A14%3A30Z®ion=usa&to=2020-04-09T18%3A14%3A30Z?by&from®ion&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"service",
"SU1Z0isxPaozGVKXdv0eY"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[{\"requests\":21,\"miss_time\":0,\"start_time\":1368734160,\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"bandwidth\":160238,\"hits\":0,\"hits_time\":0,\"miss\":0,\"body_size\":150948,\"pass\":19,\"header_size\":9290,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":9290,\"resp_body_bytes\":150948,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":14,\"status_204\":0,\"status_301\":2,\"status_302\":0,\"status_304\":0,\"errors\":0,\"hit_ratio\":null,\"status_1xx\":0,\"status_2xx\":14,\"status_3xx\":2,\"status_4xx\":5,\"status_503\":0,\"pipe\":0,\"status_5xx\":0,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404},{\"requests\":20,\"miss_time\":0,\"start_time\":1368734220,\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"bandwidth\":156504,\"hits\":0,\"hits_time\":0,\"miss\":0,\"body_size\":147806,\"pass\":17,\"header_size\":8698,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":8698,\"resp_body_bytes\":147806,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":12,\"status_204\":0,\"status_301\":3,\"status_302\":0,\"status_304\":0,\"errors\":0,\"hit_ratio\":null,\"status_1xx\":0,\"status_2xx\":12,\"status_3xx\":3,\"status_4xx\":5,\"status_503\":0,\"pipe\":0,\"status_5xx\":0,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}]}"
}
]
},
{
"name": "Get historical stats for a single service/field combination",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/service/{{service_id}}/field/{{field}}?by&from®ion&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"service",
"{{service_id}}",
"field",
"{{field}}"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches the specified field from the historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/service/SU1Z0isxPaozGVKXdv0eY/field/hit_ratio?by=day&from=2020-04-09T18%3A14%3A30Z®ion=usa&to=2020-04-09T18%3A14%3A30Z?by&from®ion&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"service",
"SU1Z0isxPaozGVKXdv0eY",
"field",
"hit_ratio"
],
"query": [
{
"key": "by",
"description": "Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."
},
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "region",
"description": "Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea.\nafrica_std - Africa.\nsouthamerica_std - South America."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Fetches the specified field from the historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start_time\":1368576000,\"hit_ratio\":0.9944},{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start_time\":1368662400,\"hit_ratio\":1}]}"
}
]
},
{
"name": "Get usage statistics",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/usage?from&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"usage"
],
"query": [
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see /stats/aggregate.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/usage?from=2020-04-09T18%3A14%3A30Z&to=2020-04-09T18%3A14%3A30Z?from&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"usage"
],
"query": [
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see /stats/aggregate.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"apac\":{\"requests\":163546563,\"compute_requests\":195733,\"bandwidth\":10735282284},\"ausnz\":{\"requests\":2888860,\"compute_requests\":8453890,\"bandwidth\":173220202333},\"usa\":{\"requests\":163546563,\"compute_requests\":337591,\"bandwidth\":153220202333},\"europe\":{\"requests\":2888860,\"compute_requests\":5385905,\"bandwidth\":10735282284}}}"
}
]
},
{
"name": "Get usage statistics per service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/usage_by_service?from&to",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"usage_by_service"
],
"query": [
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Returns usage information aggregated by service and grouped by service and region. For service stats by time period, see /stats and /stats/field/:field.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/usage_by_service?from=2020-04-09T18%3A14%3A30Z&to=2020-04-09T18%3A14%3A30Z?from&to",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"usage_by_service"
],
"query": [
{
"key": "from",
"description": "Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."
},
{
"key": "to",
"description": "Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."
}
]
},
"description": "Returns usage information aggregated by service and grouped by service and region. For service stats by time period, see /stats and /stats/field/:field.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"apac\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":60524,\"compute_requests\":51342,\"bandwidth\":6004223792},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":3,\"compute_requests\":7,\"bandwidth\":1305}},\"ausnz\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":101120,\"compute_requests\":53703,\"bandwidth\":1735577606},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":93294,\"compute_requests\":19750608,\"bandwidth\":38109995}},\"usa\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":1109033,\"compute_requests\":29148,\"bandwidth\":21642401706},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":348175,\"compute_requests\":91914,\"bandwidth\":173135847}},\"europe\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":567583,\"compute_requests\":84123,\"bandwidth\":14813592344},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":260025,\"compute_requests\":112977,\"bandwidth\":110928988}}}}"
}
]
},
{
"name": "Get month-to-date usage statistics",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/usage_by_month?billable_units&month&year",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"usage_by_month"
],
"query": [
{
"key": "billable_units",
"description": "If true, return results as billable units."
},
{
"key": "month",
"description": "2-digit month."
},
{
"key": "year",
"description": "4-digit year."
}
]
},
"description": "Returns month-to-date usage details for a given month and year. Usage details are aggregated by service and across all Fastly services, and then grouped by region. This endpoint does not use the from or to fields for selecting the date for which data is requested. Instead, it uses month and year integer fields. Both fields are optional and default to the current month and year respectively. When set, an optional billable_units field will convert bandwidth to GB and divide requests by 10,000.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/usage_by_month?billable_units=true&month=05&year=2020?billable_units&month&year",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"usage_by_month"
],
"query": [
{
"key": "billable_units",
"description": "If true, return results as billable units."
},
{
"key": "month",
"description": "2-digit month."
},
{
"key": "year",
"description": "4-digit year."
}
]
},
"description": "Returns month-to-date usage details for a given month and year. Usage details are aggregated by service and across all Fastly services, and then grouped by region. This endpoint does not use the from or to fields for selecting the date for which data is requested. Instead, it uses month and year integer fields. Both fields are optional and default to the current month and year respectively. When set, an optional billable_units field will convert bandwidth to GB and divide requests by 10,000.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"msg\":null,\"meta\":{\"from\":\"2020-05-01 00:00:00 +0000\",\"to\":\"2020-05-31 23:59:59 +0000\",\"by\":\"day\",\"region\":\"all\"},\"data\":{\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"services\":{\"SU1Z0isxPaozGVKXdv0eY\":{\"name\":\"test-service\",\"anzac\":{\"bandwidth\":28.815130509,\"requests\":131.7256,\"compute_requests\":256.3968},\"asia\":{\"bandwidth\":180.182470562,\"requests\":965.4324,\"compute_requests\":801.6574},\"europe\":{\"bandwidth\":1230.23131801,\"requests\":6082.2894,\"compute_requests\":3334.6109},\"latam\":{\"bandwidth\":18.070301895,\"requests\":93.7146,\"compute_requests\":619.1009},\"south_africa\":{\"bandwidth\":8.77620445,\"requests\":37.9704,\"compute_requests\":33.1321},\"usa\":{\"bandwidth\":2330.717545144,\"requests\":5524.7604,\"compute_requests\":5718.4171}}},\"total\":{\"anzac\":{\"bandwidth\":28.815130509,\"requests\":131.7256,\"compute_requests\":256.3968},\"asia\":{\"bandwidth\":180.182470562,\"requests\":965.4324,\"compute_requests\":801.6574},\"europe\":{\"bandwidth\":1230.23131801,\"requests\":6082.2894,\"compute_requests\":3334.6109},\"latam\":{\"bandwidth\":18.070301895,\"requests\":93.7146,\"compute_requests\":619.1009},\"south_africa\":{\"bandwidth\":8.77620445,\"requests\":37.9704,\"compute_requests\":33.1321},\"usa\":{\"bandwidth\":2330.717545144,\"requests\":5524.7604,\"compute_requests\":5718.4171}}}}"
}
]
},
{
"name": "Get region codes",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/stats/regions",
"host": [
"{{fastly_url}}"
],
"path": [
"stats",
"regions"
]
},
"description": "Fetches the list of codes for regions that are covered by the Fastly CDN service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/stats/regions",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"stats",
"regions"
]
},
"description": "Fetches the list of codes for regions that are covered by the Fastly CDN service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[\"apac\",\"ausnz\",\"usa\",\"europe\"]}"
}
]
}
],
"description": "The Historical Stats API allows you to programmatically retrieve historical caching statistics derived from your Fastly services. You can use these metrics to help you optimize your site’s data caching and analyze your site’s traffic.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| meta | object | Meta information about the scope of the query in a human readable format. |\n| msg | string | If the query was not successful, this will provide a string that explains why. |\n| status | string | Whether or not we were able to successfully execute the query. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| services | object | Organized by service id. |\n| total | object | Organized by region. |\n| name | string | The name of the service. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aia_estimated_time_saved_ms | integer | The estimated amount of time saved by responses served from the AI Accelerator semantic cache. |\n| aia_origin_usage_tokens | integer | The number of usage tokens reported by the request to the origin from AI Accelerator. |\n| aia_requests | integer | Number of requests received by AI Accelerator. |\n| aia_response_usage_tokens | integer | The usage tokens associated with the response returned from the AI Accelerator cache. |\n| aia_status_1xx | integer | Number of \"Informational\" category status codes received from AI provider. |\n| aia_status_2xx | integer | Number of \"Success\" status codes received from AI provider. |\n| aia_status_3xx | integer | Number of \"Redirection\" received from AI provider. |\n| aia_status_4xx | integer | Number of \"Client Error\" received from AI provider. |\n| aia_status_5xx | integer | Number of \"Server Error\" received from AI provider. |\n| all_edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service. |\n| all_edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service. |\n| all_error_requests | integer | Number of cache errors for a VCL service. |\n| all_hit_requests | integer | Number of cache hits for a VCL service. |\n| all_miss_requests | integer | Number of cache misses for a VCL service. |\n| all_pass_requests | integer | Number of requests that passed through the CDN without being cached for a VCL service. |\n| all_status_1xx | integer | Number of \"Informational\" category status codes delivered for all sources. |\n| all_status_2xx | integer | Number of \"Success\" status codes delivered for all sources. |\n| all_status_3xx | integer | Number of \"Redirection\" codes delivered for all sources. |\n| all_status_4xx | integer | Number of \"Client Error\" codes delivered for all sources. |\n| all_status_5xx | integer | Number of \"Server Error\" codes delivered for all sources. |\n| all_synth_requests | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement) for a VCL service. |\n| attack_blocked_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_blocked_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_logged_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was logged. |\n| attack_logged_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was logged. |\n| attack_passed_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was passed. |\n| attack_passed_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was passed. |\n| attack_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule. |\n| attack_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule. |\n| attack_resp_synth_bytes | integer | Total bytes delivered for requests that triggered a WAF rule and returned a synthetic response. |\n| bandwidth | integer | Total bytes delivered (resp_header_bytes + resp_body_bytes + bereq_header_bytes + bereq_body_bytes + compute_resp_header_bytes + compute_resp_body_bytes + compute_bereq_header_bytes + compute_bereq_body_bytes + websocket_resp_header_bytes + websocket_resp_body_bytes + websocket_bereq_header_bytes + websocket_bereq_body_bytes + fanout_resp_header_bytes + fanout_resp_body_bytes + fanout_bereq_header_bytes + fanout_bereq_body_bytes). |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| body_size | integer | Total body bytes delivered (alias for resp_body_bytes). |\n| bot_challenge_complete_tokens_checked | integer | The number of challenge-complete tokens checked. |\n| bot_challenge_complete_tokens_disabled | integer | The number of challenge-complete tokens not checked because the feature was disabled. |\n| bot_challenge_complete_tokens_failed | integer | The number of challenge-complete tokens that failed validation. |\n| bot_challenge_complete_tokens_issued | integer | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. |\n| bot_challenge_complete_tokens_passed | integer | The number of challenge-complete tokens that passed validation. |\n| bot_challenge_starts | integer | The number of challenge-start tokens created. |\n| bot_challenges_failed | integer | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. |\n| bot_challenges_issued | integer | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. |\n| bot_challenges_succeeded | integer | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. |\n| compute_bereq_body_bytes | integer | Total body bytes sent to backends (origins) by the Compute platform. |\n| compute_bereq_errors | integer | Number of backend request errors, including timeouts. |\n| compute_bereq_header_bytes | integer | Total header bytes sent to backends (origins) by the Compute platform. |\n| compute_bereqs | integer | Number of backend requests started. |\n| compute_beresp_body_bytes | integer | Total body bytes received from backends (origins) by the Compute platform. |\n| compute_beresp_header_bytes | integer | Total header bytes received from backends (origins) by the Compute platform. |\n| compute_cache_operations_count | integer | Number of cache operations executed by the Compute platform. |\n| compute_execution_time_ms | number | The amount of active CPU time used to process your requests (in milliseconds). |\n| compute_globals_limit_exceeded | integer | Number of times a guest exceeded its globals limit. |\n| compute_guest_errors | integer | Number of times a service experienced a guest code error. |\n| compute_heap_limit_exceeded | integer | Number of times a guest exceeded its heap limit. |\n| compute_ram_used | integer | The amount of RAM used for your service by Fastly (in bytes). |\n| compute_req_body_bytes | integer | Total body bytes received by the Compute platform. |\n| compute_req_header_bytes | integer | Total header bytes received by the Compute platform. |\n| compute_request_time_billed_ms | number | The total amount of request processing time you will be billed for, measured in 50 millisecond increments. |\n| compute_request_time_ms | number | The total, actual amount of time used to process your requests, including active CPU time (in milliseconds). |\n| compute_requests | integer | The total number of requests that were received for your service by Fastly. |\n| compute_resource_limit_exceeded | integer | Number of times a guest exceeded its resource limit, includes heap, stack, globals, and code execution timeout. |\n| compute_resp_body_bytes | integer | Total body bytes sent from Compute to end user. |\n| compute_resp_header_bytes | integer | Total header bytes sent from Compute to end user. |\n| compute_resp_status_1xx | integer | Number of \"Informational\" category status codes delivered by the Compute platform. |\n| compute_resp_status_2xx | integer | Number of \"Success\" category status codes delivered by the Compute platform. |\n| compute_resp_status_3xx | integer | Number of \"Redirection\" category status codes delivered by the Compute platform. |\n| compute_resp_status_4xx | integer | Number of \"Client Error\" category status codes delivered by the Compute platform. |\n| compute_resp_status_5xx | integer | Number of \"Server Error\" category status codes delivered by the Compute platform. |\n| compute_runtime_errors | integer | Number of times a service experienced a guest runtime error. |\n| compute_stack_limit_exceeded | integer | Number of times a guest exceeded its stack limit. |\n| ddos_action_blackhole | integer | The number of times the blackhole action was taken. The blackhole action quietly closes a TCP connection without sending a reset. The blackhole action quietly closes a TCP connection without notifying its peer (all TCP state is dropped). |\n| ddos_action_close | integer | The number of times the close action was taken. The close action aborts the connection as soon as possible. The close action takes effect either right after accept, right after the client hello, or right after the response was sent. |\n| ddos_action_downgrade | integer | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. |\n| ddos_action_downgraded_connections | integer | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. |\n| ddos_action_limit_streams_connections | integer | For HTTP/2, the number of connections the limit-streams action was applied to. The limit-streams action caps the allowed number of concurrent streams in a connection. |\n| ddos_action_limit_streams_requests | integer | For HTTP/2, the number of requests made on a connection for which the limit-streams action was taken. The limit-streams action caps the allowed number of concurrent streams in a connection. |\n| ddos_action_tarpit | integer | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. |\n| ddos_action_tarpit_accept | integer | The number of times the tarpit-accept action was taken. The tarpit-accept action adds a delay when accepting future connections. |\n| ddos_protection_requests_allow_count | integer | Number of requests analyzed for DDoS attacks against a customer origin or service, but with no DDoS detected. |\n| ddos_protection_requests_detect_count | integer | Number of requests classified as a DDoS attack against a customer origin or service. |\n| ddos_protection_requests_mitigate_count | integer | Number of requests classified as a DDoS attack against a customer origin or service that were mitigated by the Fastly platform. |\n| deliver_sub_count | integer | Number of executions of the vcl_deliver Varnish subroutine. |\n| deliver_sub_time | number | Time spent inside the vcl_deliver Varnish subroutine (in seconds). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_hit_resp_body_bytes | integer | Body bytes delivered for edge hits. |\n| edge_hit_resp_header_bytes | integer | Header bytes delivered for edge hits. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_miss_resp_body_bytes | integer | Body bytes delivered for edge misses. |\n| edge_miss_resp_header_bytes | integer | Header bytes delivered for edge misses. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| error_sub_count | integer | Number of executions of the vcl_error Varnish subroutine. |\n| error_sub_time | number | Time spent inside the vcl_error Varnish subroutine (in seconds). |\n| errors | integer | Number of cache errors. |\n| fanout_bereq_body_bytes | integer | Total body or message content bytes sent to backends over Fanout connections. |\n| fanout_bereq_header_bytes | integer | Total header bytes sent to backends over Fanout connections. |\n| fanout_beresp_body_bytes | integer | Total body or message content bytes received from backends over Fanout connections. |\n| fanout_beresp_header_bytes | integer | Total header bytes received from backends over Fanout connections. |\n| fanout_conn_time_ms | integer | Total duration of Fanout connections with end users. |\n| fanout_recv_publishes | integer | Total published messages received from the publish API endpoint. |\n| fanout_req_body_bytes | integer | Total body or message content bytes received from end users over Fanout connections. |\n| fanout_req_header_bytes | integer | Total header bytes received from end users over Fanout connections. |\n| fanout_resp_body_bytes | integer | Total body or message content bytes sent to end users over Fanout connections, excluding published message content. |\n| fanout_resp_header_bytes | integer | Total header bytes sent to end users over Fanout connections. |\n| fanout_send_publishes | integer | Total published messages sent to end users. |\n| fetch_sub_count | integer | Number of executions of the vcl_fetch Varnish subroutine. |\n| fetch_sub_time | number | Time spent inside the vcl_fetch Varnish subroutine (in seconds). |\n| hash_sub_count | integer | Number of executions of the vcl_hash Varnish subroutine. |\n| hash_sub_time | number | Time spent inside the vcl_hash Varnish subroutine (in seconds). |\n| header_size | integer | Total header bytes delivered (alias for resp_header_bytes). |\n| hit_ratio | number | Ratio of cache hits to cache misses (between 0 and 1). |\n| hit_resp_body_bytes | integer | Total body bytes delivered for cache hits. |\n| hit_sub_count | integer | Number of executions of the vcl_hit Varnish subroutine. |\n| hit_sub_time | number | Time spent inside the vcl_hit Varnish subroutine (in seconds). |\n| hits | integer | Number of cache hits. |\n| hits_time | number | Total amount of time spent processing cache hits (in seconds). |\n| http2 | integer | Number of requests received over HTTP/2. |\n| http3 | integer | Number of requests received over HTTP/3. |\n| imgopto | integer | Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed. |\n| imgopto_resp_body_bytes | integer | Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_resp_header_bytes | integer | Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_shield | integer | Number of responses that came from the Fastly Image Optimizer service via a shield. |\n| imgopto_shield_resp_body_bytes | integer | Total body bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_shield_resp_header_bytes | integer | Total header bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_transforms | integer | Number of transforms performed by the Fastly Image Optimizer service. |\n| imgvideo | integer | Number of video responses that came from the Fastly Image Optimizer service. |\n| imgvideo_frames | integer | Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_resp_body_bytes | integer | Total body bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_resp_header_bytes | integer | Total header bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_shield | integer | Number of video responses delivered via a shield that came from the Fastly Image Optimizer service. |\n| imgvideo_shield_frames | integer | Number of video frames delivered via a shield that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_shield_resp_body_bytes | integer | Total body bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| imgvideo_shield_resp_header_bytes | integer | Total header bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| ipv6 | integer | Number of requests that were received over IPv6. |\n| kv_store_class_a_operations | integer | The total number of class a operations for the KV store. |\n| kv_store_class_b_operations | integer | The total number of class b operations for the KV store. |\n| log | integer | Number of log lines sent. |\n| log_bytes | integer | Total log bytes sent. |\n| miss | integer | Number of cache misses. |\n| miss_resp_body_bytes | integer | Total body bytes delivered for cache misses. |\n| miss_sub_count | integer | Number of executions of the vcl_miss Varnish subroutine. |\n| miss_sub_time | number | Time spent inside the vcl_miss Varnish subroutine (in seconds). |\n| miss_time | number | Total amount of time spent processing cache misses (in seconds). |\n| ngwaf_requests_allowed_count | integer | Count of Edge WAF requests allowed. |\n| ngwaf_requests_blocked_count | integer | Count of Edge WAF requests blocked. |\n| ngwaf_requests_challenged_count | integer | Count of Edge WAF requests challenged. |\n| ngwaf_requests_logged_count | integer | Count of Edge WAF requests logged. |\n| ngwaf_requests_timeout_count | integer | Count of Edge WAF requests timed outcome. |\n| ngwaf_requests_total_count | integer | Total number of Next-Gen WAF (Edge WAF & Core WAF) requests. |\n| ngwaf_requests_unknown_count | integer | Count of Edge WAF requests with an unknown outcome. |\n| object_size_100k | integer | Number of objects served that were between 10KB and 100KB in size. |\n| object_size_100m | integer | Number of objects served that were between 10MB and 100MB in size. |\n| object_size_10k | integer | Number of objects served that were between 1KB and 10KB in size. |\n| object_size_10m | integer | Number of objects served that were between 1MB and 10MB in size. |\n| object_size_1g | integer | Number of objects served that were between 100MB and 1GB in size. |\n| object_size_1k | integer | Number of objects served that were under 1KB in size. |\n| object_size_1m | integer | Number of objects served that were between 100KB and 1MB in size. |\n| object_storage_class_a_operations_count | integer | A count of the number of Class A Object Storage operations. |\n| object_storage_class_b_operations_count | integer | A count of the number of Class B Object Storage operations. |\n| object_store_class_a_operations | integer | Use kv_store_class_a_operations. |\n| object_store_class_b_operations | integer | Use kv_store_class_b_operations. |\n| origin_cache_fetch_resp_body_bytes | integer | Body bytes received from origin for cacheable content. |\n| origin_cache_fetch_resp_header_bytes | integer | Header bytes received from an origin for cacheable content. |\n| origin_cache_fetches | integer | The total number of completed requests made to backends (origins) that returned cacheable content. |\n| origin_fetch_body_bytes | integer | Total request body bytes sent to origin. |\n| origin_fetch_header_bytes | integer | Total request header bytes sent to origin. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | number | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((edge_resp_body_bytes + edge_resp_header_bytes) - (origin_fetch_resp_body_bytes + origin_fetch_resp_header_bytes)) / (edge_resp_body_bytes + edge_resp_header_bytes). |\n| origin_revalidations | integer | Number of responses received from origin with a 304 status code in response to an If-Modified-Since or If-None-Match request. Under regular scenarios, a revalidation will imply a cache hit. However, if using Fastly Image Optimizer or segmented caching this may result in a cache miss. |\n| otfp | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_deliver_time | number | Total amount of time spent delivering a response from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| otfp_manifests | integer | Number of responses that were manifest files from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_body_bytes | integer | Total body bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_header_bytes | integer | Total header bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_body_bytes | integer | Total body bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_header_bytes | integer | Total header bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_time | number | Total amount of time spent delivering a response via a shield from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| pass | integer | Number of requests that passed through the CDN without being cached. |\n| pass_resp_body_bytes | integer | Total body bytes delivered for cache passes. |\n| pass_sub_count | integer | Number of executions of the vcl_pass Varnish subroutine. |\n| pass_sub_time | number | Time spent inside the vcl_pass Varnish subroutine (in seconds). |\n| pass_time | number | Total amount of time spent processing cache passes (in seconds). |\n| pci | integer | Number of responses with the PCI flag turned on. |\n| pipe | integer | Optional. Pipe operations performed (legacy feature). |\n| pipe_sub_count | integer | Number of executions of the vcl_pipe Varnish subroutine. |\n| pipe_sub_time | number | Time spent inside the vcl_pipe Varnish subroutine (in seconds). |\n| predeliver_sub_count | integer | Number of executions of the vcl_predeliver Varnish subroutine. |\n| predeliver_sub_time | number | Time spent inside the vcl_predeliver Varnish subroutine (in seconds). |\n| prehash_sub_count | integer | Number of executions of the vcl_prehash Varnish subroutine. |\n| prehash_sub_time | number | Time spent inside the vcl_prehash Varnish subroutine (in seconds). |\n| recv_sub_count | integer | Number of executions of the vcl_recv Varnish subroutine. |\n| recv_sub_time | number | Time spent inside the vcl_recv Varnish subroutine (in seconds). |\n| req_body_bytes | integer | Total body bytes received. |\n| req_header_bytes | integer | Total header bytes received. |\n| request_collapse_unusable_count | integer | Number of requests that were collapsed and unable to be satisfied by the resulting cache object. |\n| request_collapse_usable_count | integer | Number of requests that were collapsed and satisfied by a usable cache object. |\n| request_denied_get_head_body | integer | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered (edge_resp_body_bytes + shield_resp_body_bytes). |\n| resp_header_bytes | integer | Total header bytes delivered (edge_resp_header_bytes + shield_resp_header_bytes). |\n| restarts | integer | Number of restarts performed. |\n| segblock_origin_fetches | integer | Number of Range requests to origin for segments of resources when using segmented caching. |\n| segblock_shield_fetches | integer | Number of Range requests to a shield for segments of resources when using segmented caching. |\n| service_id | string | Alphanumeric string identifying the service. |\n| shield | integer | Number of requests from edge to the shield POP. |\n| shield_cache_fetches | integer | The total number of completed requests made to shields that returned cacheable content. |\n| shield_fetch_body_bytes | integer | Total request body bytes sent to a shield. |\n| shield_fetch_header_bytes | integer | Total request header bytes sent to a shield. |\n| shield_fetch_resp_body_bytes | integer | Total response body bytes sent from a shield to the edge. |\n| shield_fetch_resp_header_bytes | integer | Total response header bytes sent from a shield to the edge. |\n| shield_fetches | integer | Number of requests made from one Fastly POP to another, as part of shielding. |\n| shield_hit_requests | integer | Number of requests that resulted in a hit at a shield. |\n| shield_hit_resp_body_bytes | integer | Body bytes delivered for shield hits. |\n| shield_hit_resp_header_bytes | integer | Header bytes delivered for shield hits. |\n| shield_miss_requests | integer | Number of requests that resulted in a miss at a shield. |\n| shield_miss_resp_body_bytes | integer | Body bytes delivered for shield misses. |\n| shield_miss_resp_header_bytes | integer | Header bytes delivered for shield misses. |\n| shield_resp_body_bytes | integer | Total body bytes delivered via a shield. |\n| shield_resp_header_bytes | integer | Total header bytes delivered via a shield. |\n| shield_revalidations | integer | Number of responses received from origin with a 304 status code, in response to an If-Modified-Since or If-None-Match request to a shield. Under regular scenarios, a revalidation will imply a cache hit. However, if using segmented caching this may result in a cache miss. |\n| start_time | integer | Timestamp for the start of the time period being reported. |\n| status_1xx | integer | Number of \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses sent with status code 200 (Success). |\n| status_204 | integer | Number of responses sent with status code 204 (No Content). |\n| status_206 | integer | Number of responses sent with status code 206 (Partial Content). |\n| status_2xx | integer | Number of \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses sent with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses sent with status code 302 (Found). |\n| status_304 | integer | Number of responses sent with status code 304 (Not Modified). |\n| status_3xx | integer | Number of \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses sent with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses sent with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses sent with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses sent with status code 404 (Not Found). |\n| status_406 | integer | Number of responses sent with status code 406 (Not Acceptable). |\n| status_416 | integer | Number of responses sent with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses sent with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses sent with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses sent with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses sent with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses sent with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses sent with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses sent with status code 505 (HTTP Version Not Supported). |\n| status_530 | integer | Number of responses sent with status code 530. |\n| status_5xx | integer | Number of \"Server Error\" codes delivered. |\n| synth | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement). |\n| tls | integer | Number of requests that were received over TLS. |\n| tls_handshake_sent_bytes | integer | Number of bytes transferred during TLS handshake. |\n| tls_v10 | integer | Number of requests received over TLS 1.0. |\n| tls_v11 | integer | Number of requests received over TLS 1.1. |\n| tls_v12 | integer | Number of requests received over TLS 1.2. |\n| tls_v13 | integer | Number of requests received over TLS 1.3. |\n| uncacheable | integer | Number of requests that were designated uncachable. |\n| video | integer | Number of responses with the video segment or video manifest MIME type (i.e., application/x-mpegurl, application/vnd.apple.mpegurl, application/f4m, application/dash+xml, application/vnd.ms-sstr+xml, ideo/mp2t, audio/aac, video/f4f, video/x-flv, video/mp4, audio/mp4). |\n| waf_blocked | integer | Number of requests that triggered a WAF rule and were blocked. |\n| waf_logged | integer | Number of requests that triggered a WAF rule and were logged. |\n| waf_passed | integer | Number of requests that triggered a WAF rule and were passed. |\n| websocket_bereq_body_bytes | integer | Total message content bytes sent to backends over passthrough WebSocket connections. |\n| websocket_bereq_header_bytes | integer | Total header bytes sent to backends over passthrough WebSocket connections. |\n| websocket_beresp_body_bytes | integer | Total message content bytes received from backends over passthrough WebSocket connections. |\n| websocket_beresp_header_bytes | integer | Total header bytes received from backends over passthrough WebSocket connections. |\n| websocket_conn_time_ms | integer | Total duration of passthrough WebSocket connections with end users. |\n| websocket_req_body_bytes | integer | Total message content bytes received from end users over passthrough WebSocket connections. |\n| websocket_req_header_bytes | integer | Total header bytes received from end users over passthrough WebSocket connections. |\n| websocket_resp_body_bytes | integer | Total message content bytes sent to end users over passthrough WebSocket connections. |\n| websocket_resp_header_bytes | integer | Total header bytes sent to end users over passthrough WebSocket connections. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Real-time analytics",
"item": [
{
"name": "Get real-time data from specified time",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/channel/{{service_id}}/ts/{{timestamp_in_seconds}}",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"channel",
"{{service_id}}",
"ts",
"{{timestamp_in_seconds}}"
]
},
"description": "Get real-time data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/channel/SU1Z0isxPaozGVKXdv0eY/ts/1608560817",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"channel",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"1608560817"
]
},
"description": "Get real-time data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"LCY\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1}},\"aggregated\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1},\"recorded\":1608560817},{\"datacenter\":{\"STP\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732,\"compute_request_time_billed_ms\":750}},\"aggregated\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732,\"compute_request_time_billed_ms\":750},\"recorded\":1608560818}],\"Timestamp\":1608560827,\"AggregateDelay\":9}"
}
]
},
{
"name": "Get real-time data for the last 120 seconds",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/channel/{{service_id}}/ts/h",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"channel",
"{{service_id}}",
"ts",
"h"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/channel/SU1Z0isxPaozGVKXdv0eY/ts/h",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"channel",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"h"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"LCY\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1}},\"aggregated\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1},\"recorded\":1608560817},{\"datacenter\":{\"STP\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732,\"compute_request_time_billed_ms\":750}},\"aggregated\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732,\"compute_request_time_billed_ms\":750},\"recorded\":1608560818}],\"Timestamp\":1608560827,\"AggregateDelay\":9}"
}
]
},
{
"name": "Get a limited number of real-time data entries",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/channel/{{service_id}}/ts/h/limit/{{max_entries}}",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"channel",
"{{service_id}}",
"ts",
"h",
"limit",
"{{max_entries}}"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service, up to a maximum of max_entries entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/channel/SU1Z0isxPaozGVKXdv0eY/ts/h/limit/1",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"channel",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"h",
"limit",
"1"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service, up to a maximum of max_entries entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"LCY\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1}},\"aggregated\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1},\"recorded\":1608560817},{\"datacenter\":{\"STP\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732,\"compute_request_time_billed_ms\":750}},\"aggregated\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732,\"compute_request_time_billed_ms\":750},\"recorded\":1608560818}],\"Timestamp\":1608560827,\"AggregateDelay\":9}"
}
]
}
],
"description": "The real-time analytics API offers a standardized set of data about traffic received by a specified service in one-second time periods up to the last complete second.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| AggregateDelay | integer | How long the system will wait before aggregating messages for each second. The most recent data returned will have happened at the moment of the request, minus the aggregation delay. |\n| Data | array | A list of records, each representing one second of time. |\n| Timestamp | integer | Value to use for subsequent requests. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aggregated | object | Aggregates measurements across all Fastly POPs. |\n| datacenter | object | Groups measurements by POP. See the POPs API for details of POP identifiers. |\n| recorded | integer | The Unix timestamp at which this record's data was generated. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aia_estimated_time_saved_ms | integer | The estimated amount of time saved by responses served from the AI Accelerator semantic cache. |\n| aia_origin_usage_tokens | integer | The number of usage tokens reported by the request to the origin from AI Accelerator. |\n| aia_requests | integer | Number of requests received by AI Accelerator. |\n| aia_response_usage_tokens | integer | The usage tokens associated with the response returned from the AI Accelerator cache. |\n| aia_status_1xx | integer | Number of \"Informational\" category status codes received from AI provider. |\n| aia_status_2xx | integer | Number of \"Success\" status codes received from AI provider. |\n| aia_status_3xx | integer | Number of \"Redirection\" received from AI provider. |\n| aia_status_4xx | integer | Number of \"Client Error\" received from AI provider. |\n| aia_status_5xx | integer | Number of \"Server Error\" received from AI provider. |\n| all_edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service. |\n| all_edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service. |\n| all_error_requests | integer | Number of cache errors for a VCL service. |\n| all_hit_requests | integer | Number of cache hits for a VCL service. |\n| all_miss_requests | integer | Number of cache misses for a VCL service. |\n| all_pass_requests | integer | Number of requests that passed through the CDN without being cached for a VCL service. |\n| all_status_1xx | integer | Number of \"Informational\" category status codes delivered for all sources. |\n| all_status_2xx | integer | Number of \"Success\" status codes delivered for all sources. |\n| all_status_3xx | integer | Number of \"Redirection\" codes delivered for all sources. |\n| all_status_4xx | integer | Number of \"Client Error\" codes delivered for all sources. |\n| all_status_5xx | integer | Number of \"Server Error\" codes delivered for all sources. |\n| all_synth_requests | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement) for a VCL service. |\n| attack_blocked_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_blocked_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_logged_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was logged. |\n| attack_logged_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was logged. |\n| attack_passed_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was passed. |\n| attack_passed_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was passed. |\n| attack_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule. |\n| attack_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule. |\n| attack_resp_synth_bytes | integer | Total bytes delivered for requests that triggered a WAF rule and returned a synthetic response. |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| body_size | integer | Total body bytes delivered (alias for resp_body_bytes). |\n| bot_challenge_complete_tokens_checked | integer | The number of challenge-complete tokens checked. |\n| bot_challenge_complete_tokens_disabled | integer | The number of challenge-complete tokens not checked because the feature was disabled. |\n| bot_challenge_complete_tokens_failed | integer | The number of challenge-complete tokens that failed validation. |\n| bot_challenge_complete_tokens_issued | integer | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. |\n| bot_challenge_complete_tokens_passed | integer | The number of challenge-complete tokens that passed validation. |\n| bot_challenge_starts | integer | The number of challenge-start tokens created. |\n| bot_challenges_failed | integer | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. |\n| bot_challenges_issued | integer | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. |\n| bot_challenges_succeeded | integer | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. |\n| compute_bereq_body_bytes | integer | Total body bytes sent to backends (origins) by the Compute platform. |\n| compute_bereq_errors | integer | Number of backend request errors, including timeouts. |\n| compute_bereq_header_bytes | integer | Total header bytes sent to backends (origins) by the Compute platform. |\n| compute_bereqs | integer | Number of backend requests started. |\n| compute_beresp_body_bytes | integer | Total body bytes received from backends (origins) by the Compute platform. |\n| compute_beresp_header_bytes | integer | Total header bytes received from backends (origins) by the Compute platform. |\n| compute_cache_operations_count | integer | Number of cache operations executed by the Compute platform. |\n| compute_execution_time_ms | number | The amount of active CPU time used to process your requests (in milliseconds). |\n| compute_globals_limit_exceeded | integer | Number of times a guest exceeded its globals limit. |\n| compute_guest_errors | integer | Number of times a service experienced a guest code error. |\n| compute_heap_limit_exceeded | integer | Number of times a guest exceeded its heap limit. |\n| compute_ram_used | integer | The amount of RAM used for your service by Fastly (in bytes). |\n| compute_req_body_bytes | integer | Total body bytes received by the Compute platform. |\n| compute_req_header_bytes | integer | Total header bytes received by the Compute platform. |\n| compute_request_time_billed_ms | number | The total amount of request processing time you will be billed for, measured in 50 millisecond increments. |\n| compute_request_time_ms | number | The total, actual amount of time used to process your requests, including active CPU time (in milliseconds). |\n| compute_requests | integer | The total number of requests that were received for your service by Fastly. |\n| compute_resource_limit_exceeded | integer | Number of times a guest exceeded its resource limit, includes heap, stack, globals, and code execution timeout. |\n| compute_resp_body_bytes | integer | Total body bytes sent from Compute to end user. |\n| compute_resp_header_bytes | integer | Total header bytes sent from Compute to end user. |\n| compute_resp_status_1xx | integer | Number of \"Informational\" category status codes delivered by the Compute platform. |\n| compute_resp_status_2xx | integer | Number of \"Success\" category status codes delivered by the Compute platform. |\n| compute_resp_status_3xx | integer | Number of \"Redirection\" category status codes delivered by the Compute platform. |\n| compute_resp_status_4xx | integer | Number of \"Client Error\" category status codes delivered by the Compute platform. |\n| compute_resp_status_5xx | integer | Number of \"Server Error\" category status codes delivered by the Compute platform. |\n| compute_runtime_errors | integer | Number of times a service experienced a guest runtime error. |\n| compute_stack_limit_exceeded | integer | Number of times a guest exceeded its stack limit. |\n| ddos_action_blackhole | integer | The number of times the blackhole action was taken. The blackhole action quietly closes a TCP connection without sending a reset. The blackhole action quietly closes a TCP connection without notifying its peer (all TCP state is dropped). |\n| ddos_action_close | integer | The number of times the close action was taken. The close action aborts the connection as soon as possible. The close action takes effect either right after accept, right after the client hello, or right after the response was sent. |\n| ddos_action_downgrade | integer | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. |\n| ddos_action_downgraded_connections | integer | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. |\n| ddos_action_limit_streams_connections | integer | For HTTP/2, the number of connections the limit-streams action was applied to. The limit-streams action caps the allowed number of concurrent streams in a connection. |\n| ddos_action_limit_streams_requests | integer | For HTTP/2, the number of requests made on a connection for which the limit-streams action was taken. The limit-streams action caps the allowed number of concurrent streams in a connection. |\n| ddos_action_tarpit | integer | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. |\n| ddos_action_tarpit_accept | integer | The number of times the tarpit-accept action was taken. The tarpit-accept action adds a delay when accepting future connections. |\n| ddos_protection_requests_allow_count | integer | Number of requests analyzed for DDoS attacks against a customer origin or service, but with no DDoS detected. |\n| ddos_protection_requests_detect_count | integer | Number of requests classified as a DDoS attack against a customer origin or service. |\n| ddos_protection_requests_mitigate_count | integer | Number of requests classified as a DDoS attack against a customer origin or service that were mitigated by the Fastly platform. |\n| deliver_sub_count | integer | Number of executions of the vcl_deliver Varnish subroutine. |\n| deliver_sub_time | number | Time spent inside the vcl_deliver Varnish subroutine (in nanoseconds). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_hit_resp_body_bytes | integer | Body bytes delivered for edge hits. |\n| edge_hit_resp_header_bytes | integer | Header bytes delivered for edge hits. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_miss_resp_body_bytes | integer | Body bytes delivered for edge misses. |\n| edge_miss_resp_header_bytes | integer | Header bytes delivered for edge misses. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| error_sub_count | integer | Number of executions of the vcl_error Varnish subroutine. |\n| error_sub_time | number | Time spent inside the vcl_error Varnish subroutine (in nanoseconds). |\n| errors | integer | Number of cache errors. |\n| fanout_bereq_body_bytes | integer | Total body or message content bytes sent to backends over Fanout connections. |\n| fanout_bereq_header_bytes | integer | Total header bytes sent to backends over Fanout connections. |\n| fanout_beresp_body_bytes | integer | Total body or message content bytes received from backends over Fanout connections. |\n| fanout_beresp_header_bytes | integer | Total header bytes received from backends over Fanout connections. |\n| fanout_conn_time_ms | integer | Total duration of Fanout connections with end users. |\n| fanout_recv_publishes | integer | Total published messages received from the publish API endpoint. |\n| fanout_req_body_bytes | integer | Total body or message content bytes received from end users over Fanout connections. |\n| fanout_req_header_bytes | integer | Total header bytes received from end users over Fanout connections. |\n| fanout_resp_body_bytes | integer | Total body or message content bytes sent to end users over Fanout connections, excluding published message content. |\n| fanout_resp_header_bytes | integer | Total header bytes sent to end users over Fanout connections. |\n| fanout_send_publishes | integer | Total published messages sent to end users. |\n| fetch_sub_count | integer | Number of executions of the vcl_fetch Varnish subroutine. |\n| fetch_sub_time | number | Time spent inside the vcl_fetch Varnish subroutine (in nanoseconds). |\n| hash_sub_count | integer | Number of executions of the vcl_hash Varnish subroutine. |\n| hash_sub_time | number | Time spent inside the vcl_hash Varnish subroutine (in nanoseconds). |\n| header_size | integer | Total header bytes delivered (alias for resp_header_bytes). |\n| hit_resp_body_bytes | integer | Total body bytes delivered for cache hits. |\n| hit_sub_count | integer | Number of executions of the vcl_hit Varnish subroutine. |\n| hit_sub_time | number | Time spent inside the vcl_hit Varnish subroutine (in nanoseconds). |\n| hits | integer | Number of cache hits. |\n| hits_time | number | Total amount of time spent processing cache hits (in seconds). |\n| http2 | integer | Number of requests received over HTTP/2. |\n| http3 | integer | Number of requests received over HTTP/3. |\n| imgopto | integer | Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed. |\n| imgopto_resp_body_bytes | integer | Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_resp_header_bytes | integer | Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_shield | integer | Number of responses that came from the Fastly Image Optimizer service via a shield. |\n| imgopto_shield_resp_body_bytes | integer | Total body bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_shield_resp_header_bytes | integer | Total header bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_transforms | integer | Number of transforms performed by the Fastly Image Optimizer service. |\n| imgvideo | integer | Number of video responses that came from the Fastly Image Optimizer service. |\n| imgvideo_frames | integer | Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_resp_body_bytes | integer | Total body bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_resp_header_bytes | integer | Total header bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_shield | integer | Number of video responses delivered via a shield that came from the Fastly Image Optimizer service. |\n| imgvideo_shield_frames | integer | Number of video frames delivered via a shield that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_shield_resp_body_bytes | integer | Total body bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| imgvideo_shield_resp_header_bytes | integer | Total header bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| ipv6 | integer | Number of requests that were received over IPv6. |\n| kv_store_class_a_operations | integer | The total number of class a operations for the KV store. |\n| kv_store_class_b_operations | integer | The total number of class b operations for the KV store. |\n| log | integer | Number of log lines sent. |\n| log_bytes | integer | Total log bytes sent. |\n| logging | integer | Number of log lines sent (alias for log). |\n| miss | integer | Number of cache misses. |\n| miss_histogram | object | A histogram. The value in each bucket is the number of requests to the origin whose responses arrived during the time period represented by the bucket. The key of each bucket represents the upper bound (in response time) of that bucket. The buckets vary in width and cover the time periods 0-10ms (in 1ms increments), 10-250ms (in 10ms increments), 250-1,000ms (in 50ms increments), 1,000-3,000ms (in 100ms increments), 3,000-10,000ms (in 500 ms increments), 10,000-20,000ms (in 1,000ms increments), 20,000-60,000ms (in 5,000ms increments), and 60,000ms through infinity (in a single bucket). |\n| miss_resp_body_bytes | integer | Total body bytes delivered for cache misses. |\n| miss_sub_count | integer | Number of executions of the vcl_miss Varnish subroutine. |\n| miss_sub_time | number | Time spent inside the vcl_miss Varnish subroutine (in nanoseconds). |\n| miss_time | number | Total amount of time spent processing cache misses (in seconds). |\n| object_size_100k | integer | Number of objects served that were between 10KB and 100KB in size. |\n| object_size_100m | integer | Number of objects served that were between 10MB and 100MB in size. |\n| object_size_10k | integer | Number of objects served that were between 1KB and 10KB in size. |\n| object_size_10m | integer | Number of objects served that were between 1MB and 10MB in size. |\n| object_size_1g | integer | Number of objects served that were between 100MB and 1GB in size. |\n| object_size_1k | integer | Number of objects served that were under 1KB in size. |\n| object_size_1m | integer | Number of objects served that were between 100KB and 1MB in size. |\n| object_size_other | integer | Number of objects served that were larger than 1GB in size. |\n| object_storage_class_a_operations_count | integer | A count of the number of Class A Object Storage operations. |\n| object_storage_class_b_operations_count | integer | A count of the number of Class B Object Storage operations. |\n| object_store_class_a_operations | integer | Use kv_store_class_a_operations. |\n| object_store_class_b_operations | integer | Use kv_store_class_b_operations. |\n| origin_cache_fetch_resp_body_bytes | integer | Body bytes received from origin for cacheable content. |\n| origin_cache_fetch_resp_header_bytes | integer | Header bytes received from an origin for cacheable content. |\n| origin_cache_fetches | integer | The total number of completed requests made to backends (origins) that returned cacheable content. |\n| origin_fetch_body_bytes | integer | Total request body bytes sent to origin. |\n| origin_fetch_header_bytes | integer | Total request header bytes sent to origin. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | number | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((edge_resp_body_bytes + edge_resp_header_bytes) - (origin_fetch_resp_body_bytes + origin_fetch_resp_header_bytes)) / (edge_resp_body_bytes + edge_resp_header_bytes). |\n| origin_revalidations | integer | Number of responses received from origin with a 304 status code in response to an If-Modified-Since or If-None-Match request. Under regular scenarios, a revalidation will imply a cache hit. However, if using Fastly Image Optimizer or segmented caching this may result in a cache miss. |\n| otfp | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_deliver_time | number | Total amount of time spent delivering a response from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| otfp_manifests | integer | Number of responses that were manifest files from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_body_bytes | integer | Total body bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_header_bytes | integer | Total header bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand via a shield. |\n| otfp_shield_resp_body_bytes | integer | Total body bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_header_bytes | integer | Total header bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_time | number | Total amount of time spent delivering a response via a shield from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| pass | integer | Number of requests that passed through the CDN without being cached. |\n| pass_resp_body_bytes | integer | Total body bytes delivered for cache passes. |\n| pass_sub_count | integer | Number of executions of the vcl_pass Varnish subroutine. |\n| pass_sub_time | number | Time spent inside the vcl_pass Varnish subroutine (in nanoseconds). |\n| pass_time | number | Total amount of time spent processing cache passes (in seconds). |\n| pci | integer | Number of responses with the PCI flag turned on. |\n| pipe_sub_count | integer | Number of executions of the vcl_pipe Varnish subroutine. |\n| pipe_sub_time | number | Time spent inside the vcl_pipe Varnish subroutine (in nanoseconds). |\n| predeliver_sub_count | integer | Number of executions of the vcl_predeliver Varnish subroutine. |\n| predeliver_sub_time | number | Time spent inside the vcl_predeliver Varnish subroutine (in nanoseconds). |\n| prehash_sub_count | integer | Number of executions of the vcl_prehash Varnish subroutine. |\n| prehash_sub_time | number | Time spent inside the vcl_prehash Varnish subroutine (in nanoseconds). |\n| recv_sub_count | integer | Number of executions of the vcl_recv Varnish subroutine. |\n| recv_sub_time | number | Time spent inside the vcl_recv Varnish subroutine (in nanoseconds). |\n| req_body_bytes | integer | Total body bytes received. |\n| req_header_bytes | integer | Total header bytes received. |\n| request_collapse_unusable_count | integer | Number of requests that were collapsed and unable to be satisfied by the resulting cache object. |\n| request_collapse_usable_count | integer | Number of requests that were collapsed and satisfied by a usable cache object. |\n| request_denied_get_head_body | integer | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered (edge_resp_body_bytes + shield_resp_body_bytes). |\n| resp_header_bytes | integer | Total header bytes delivered (edge_resp_header_bytes + shield_resp_header_bytes). |\n| restarts | integer | Number of restarts performed. |\n| segblock_origin_fetches | integer | Number of Range requests to origin for segments of resources when using segmented caching. |\n| segblock_shield_fetches | integer | Number of Range requests to a shield for segments of resources when using segmented caching. |\n| shield | integer | Number of requests from edge to the shield POP. |\n| shield_cache_fetches | integer | The total number of completed requests made to shields that returned cacheable content. |\n| shield_fetch_body_bytes | integer | Total request body bytes sent to a shield. |\n| shield_fetch_header_bytes | integer | Total request header bytes sent to a shield. |\n| shield_fetch_resp_body_bytes | integer | Total response body bytes sent from a shield to the edge. |\n| shield_fetch_resp_header_bytes | integer | Total response header bytes sent from a shield to the edge. |\n| shield_fetches | integer | Number of requests made from one Fastly POP to another, as part of shielding. |\n| shield_hit_requests | integer | Number of requests that resulted in a hit at a shield. |\n| shield_hit_resp_body_bytes | integer | Body bytes delivered for shield hits. |\n| shield_hit_resp_header_bytes | integer | Header bytes delivered for shield hits. |\n| shield_miss_requests | integer | Number of requests that resulted in a miss at a shield. |\n| shield_miss_resp_body_bytes | integer | Body bytes delivered for shield misses. |\n| shield_miss_resp_header_bytes | integer | Header bytes delivered for shield misses. |\n| shield_resp_body_bytes | integer | Total body bytes delivered via a shield. |\n| shield_resp_header_bytes | integer | Total header bytes delivered via a shield. |\n| shield_revalidations | integer | Number of responses received from origin with a 304 status code, in response to an If-Modified-Since or If-None-Match request to a shield. Under regular scenarios, a revalidation will imply a cache hit. However, if using segmented caching this may result in a cache miss. |\n| status_1xx | integer | Number of \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses sent with status code 200 (Success). |\n| status_204 | integer | Number of responses sent with status code 204 (No Content). |\n| status_206 | integer | Number of responses sent with status code 206 (Partial Content). |\n| status_2xx | integer | Number of \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses sent with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses sent with status code 302 (Found). |\n| status_304 | integer | Number of responses sent with status code 304 (Not Modified). |\n| status_3xx | integer | Number of \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses sent with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses sent with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses sent with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses sent with status code 404 (Not Found). |\n| status_406 | integer | Number of responses sent with status code 406 (Not Acceptable). |\n| status_416 | integer | Number of responses sent with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses sent with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses sent with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses sent with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses sent with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses sent with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses sent with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses sent with status code 505 (HTTP Version Not Supported). |\n| status_530 | integer | Number of responses sent with status code 530. |\n| status_5xx | integer | Number of \"Server Error\" codes delivered. |\n| synth | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement). |\n| tls | integer | Number of requests that were received over TLS. |\n| tls_v10 | integer | Number of requests received over TLS 1.0. |\n| tls_v11 | integer | Number of requests received over TLS 1.1. |\n| tls_v12 | integer | Number of requests received over TLS 1.2. |\n| tls_v13 | integer | Number of requests received over TLS 1.3. |\n| uncacheable | integer | Number of requests that were designated uncachable. |\n| video | integer | Number of responses with the video segment or video manifest MIME type (i.e., application/x-mpegurl, application/vnd.apple.mpegurl, application/f4m, application/dash+xml, application/vnd.ms-sstr+xml, ideo/mp2t, audio/aac, video/f4f, video/x-flv, video/mp4, audio/mp4). |\n| waf_blocked | integer | Number of requests that triggered a WAF rule and were blocked. |\n| waf_logged | integer | Number of requests that triggered a WAF rule and were logged. |\n| waf_passed | integer | Number of requests that triggered a WAF rule and were passed. |\n| websocket_bereq_body_bytes | integer | Total message content bytes sent to backends over passthrough WebSocket connections. |\n| websocket_bereq_header_bytes | integer | Total header bytes sent to backends over passthrough WebSocket connections. |\n| websocket_beresp_body_bytes | integer | Total message content bytes received from backends over passthrough WebSocket connections. |\n| websocket_beresp_header_bytes | integer | Total header bytes received from backends over passthrough WebSocket connections. |\n| websocket_conn_time_ms | integer | Total duration of passthrough WebSocket connections with end users. |\n| websocket_req_body_bytes | integer | Total message content bytes received from end users over passthrough WebSocket connections. |\n| websocket_req_header_bytes | integer | Total header bytes received from end users over passthrough WebSocket connections. |\n| websocket_resp_body_bytes | integer | Total message content bytes sent to end users over passthrough WebSocket connections. |\n| websocket_resp_header_bytes | integer | Total header bytes sent to end users over passthrough WebSocket connections. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aia_estimated_time_saved_ms | integer | The estimated amount of time saved by responses served from the AI Accelerator semantic cache. |\n| aia_origin_usage_tokens | integer | The number of usage tokens reported by the request to the origin from AI Accelerator. |\n| aia_requests | integer | Number of requests received by AI Accelerator. |\n| aia_response_usage_tokens | integer | The usage tokens associated with the response returned from the AI Accelerator cache. |\n| aia_status_1xx | integer | Number of \"Informational\" category status codes received from AI provider. |\n| aia_status_2xx | integer | Number of \"Success\" status codes received from AI provider. |\n| aia_status_3xx | integer | Number of \"Redirection\" received from AI provider. |\n| aia_status_4xx | integer | Number of \"Client Error\" received from AI provider. |\n| aia_status_5xx | integer | Number of \"Server Error\" received from AI provider. |\n| all_edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge for a VCL service. |\n| all_edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge for a VCL service. |\n| all_error_requests | integer | Number of cache errors for a VCL service. |\n| all_hit_requests | integer | Number of cache hits for a VCL service. |\n| all_miss_requests | integer | Number of cache misses for a VCL service. |\n| all_pass_requests | integer | Number of requests that passed through the CDN without being cached for a VCL service. |\n| all_status_1xx | integer | Number of \"Informational\" category status codes delivered for all sources. |\n| all_status_2xx | integer | Number of \"Success\" status codes delivered for all sources. |\n| all_status_3xx | integer | Number of \"Redirection\" codes delivered for all sources. |\n| all_status_4xx | integer | Number of \"Client Error\" codes delivered for all sources. |\n| all_status_5xx | integer | Number of \"Server Error\" codes delivered for all sources. |\n| all_synth_requests | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement) for a VCL service. |\n| attack_blocked_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_blocked_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_logged_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was logged. |\n| attack_logged_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was logged. |\n| attack_passed_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was passed. |\n| attack_passed_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was passed. |\n| attack_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule. |\n| attack_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule. |\n| attack_resp_synth_bytes | integer | Total bytes delivered for requests that triggered a WAF rule and returned a synthetic response. |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| body_size | integer | Total body bytes delivered (alias for resp_body_bytes). |\n| bot_challenge_complete_tokens_checked | integer | The number of challenge-complete tokens checked. |\n| bot_challenge_complete_tokens_disabled | integer | The number of challenge-complete tokens not checked because the feature was disabled. |\n| bot_challenge_complete_tokens_failed | integer | The number of challenge-complete tokens that failed validation. |\n| bot_challenge_complete_tokens_issued | integer | The number of challenge-complete tokens issued. For example, issuing a challenge-complete token after a series of CAPTCHA challenges ending in success. |\n| bot_challenge_complete_tokens_passed | integer | The number of challenge-complete tokens that passed validation. |\n| bot_challenge_starts | integer | The number of challenge-start tokens created. |\n| bot_challenges_failed | integer | The number of failed challenge solutions processed. For example, an incorrect CAPTCHA solution. |\n| bot_challenges_issued | integer | The number of challenges issued. For example, the issuance of a CAPTCHA challenge. |\n| bot_challenges_succeeded | integer | The number of successful challenge solutions processed. For example, a correct CAPTCHA solution. |\n| compute_bereq_body_bytes | integer | Total body bytes sent to backends (origins) by the Compute platform. |\n| compute_bereq_errors | integer | Number of backend request errors, including timeouts. |\n| compute_bereq_header_bytes | integer | Total header bytes sent to backends (origins) by the Compute platform. |\n| compute_bereqs | integer | Number of backend requests started. |\n| compute_beresp_body_bytes | integer | Total body bytes received from backends (origins) by the Compute platform. |\n| compute_beresp_header_bytes | integer | Total header bytes received from backends (origins) by the Compute platform. |\n| compute_cache_operations_count | integer | Number of cache operations executed by the Compute platform. |\n| compute_execution_time_ms | number | The amount of active CPU time used to process your requests (in milliseconds). |\n| compute_globals_limit_exceeded | integer | Number of times a guest exceeded its globals limit. |\n| compute_guest_errors | integer | Number of times a service experienced a guest code error. |\n| compute_heap_limit_exceeded | integer | Number of times a guest exceeded its heap limit. |\n| compute_ram_used | integer | The amount of RAM used for your service by Fastly (in bytes). |\n| compute_req_body_bytes | integer | Total body bytes received by the Compute platform. |\n| compute_req_header_bytes | integer | Total header bytes received by the Compute platform. |\n| compute_request_time_billed_ms | number | The total amount of request processing time you will be billed for, measured in 50 millisecond increments. |\n| compute_request_time_ms | number | The total, actual amount of time used to process your requests, including active CPU time (in milliseconds). |\n| compute_requests | integer | The total number of requests that were received for your service by Fastly. |\n| compute_resource_limit_exceeded | integer | Number of times a guest exceeded its resource limit, includes heap, stack, globals, and code execution timeout. |\n| compute_resp_body_bytes | integer | Total body bytes sent from Compute to end user. |\n| compute_resp_header_bytes | integer | Total header bytes sent from Compute to end user. |\n| compute_resp_status_1xx | integer | Number of \"Informational\" category status codes delivered by the Compute platform. |\n| compute_resp_status_2xx | integer | Number of \"Success\" category status codes delivered by the Compute platform. |\n| compute_resp_status_3xx | integer | Number of \"Redirection\" category status codes delivered by the Compute platform. |\n| compute_resp_status_4xx | integer | Number of \"Client Error\" category status codes delivered by the Compute platform. |\n| compute_resp_status_5xx | integer | Number of \"Server Error\" category status codes delivered by the Compute platform. |\n| compute_runtime_errors | integer | Number of times a service experienced a guest runtime error. |\n| compute_stack_limit_exceeded | integer | Number of times a guest exceeded its stack limit. |\n| ddos_action_blackhole | integer | The number of times the blackhole action was taken. The blackhole action quietly closes a TCP connection without sending a reset. The blackhole action quietly closes a TCP connection without notifying its peer (all TCP state is dropped). |\n| ddos_action_close | integer | The number of times the close action was taken. The close action aborts the connection as soon as possible. The close action takes effect either right after accept, right after the client hello, or right after the response was sent. |\n| ddos_action_downgrade | integer | The number of times the downgrade action was taken. The downgrade action restricts the client to http1. |\n| ddos_action_downgraded_connections | integer | The number of connections the downgrade action was applied to. The downgrade action restricts the connection to http1. |\n| ddos_action_limit_streams_connections | integer | For HTTP/2, the number of connections the limit-streams action was applied to. The limit-streams action caps the allowed number of concurrent streams in a connection. |\n| ddos_action_limit_streams_requests | integer | For HTTP/2, the number of requests made on a connection for which the limit-streams action was taken. The limit-streams action caps the allowed number of concurrent streams in a connection. |\n| ddos_action_tarpit | integer | The number of times the tarpit action was taken. The tarpit action delays writing the response to the client. |\n| ddos_action_tarpit_accept | integer | The number of times the tarpit-accept action was taken. The tarpit-accept action adds a delay when accepting future connections. |\n| ddos_protection_requests_allow_count | integer | Number of requests analyzed for DDoS attacks against a customer origin or service, but with no DDoS detected. |\n| ddos_protection_requests_detect_count | integer | Number of requests classified as a DDoS attack against a customer origin or service. |\n| ddos_protection_requests_mitigate_count | integer | Number of requests classified as a DDoS attack against a customer origin or service that were mitigated by the Fastly platform. |\n| deliver_sub_count | integer | Number of executions of the vcl_deliver Varnish subroutine. |\n| deliver_sub_time | number | Time spent inside the vcl_deliver Varnish subroutine (in nanoseconds). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_hit_resp_body_bytes | integer | Body bytes delivered for edge hits. |\n| edge_hit_resp_header_bytes | integer | Header bytes delivered for edge hits. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_miss_resp_body_bytes | integer | Body bytes delivered for edge misses. |\n| edge_miss_resp_header_bytes | integer | Header bytes delivered for edge misses. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| error_sub_count | integer | Number of executions of the vcl_error Varnish subroutine. |\n| error_sub_time | number | Time spent inside the vcl_error Varnish subroutine (in nanoseconds). |\n| errors | integer | Number of cache errors. |\n| fanout_bereq_body_bytes | integer | Total body or message content bytes sent to backends over Fanout connections. |\n| fanout_bereq_header_bytes | integer | Total header bytes sent to backends over Fanout connections. |\n| fanout_beresp_body_bytes | integer | Total body or message content bytes received from backends over Fanout connections. |\n| fanout_beresp_header_bytes | integer | Total header bytes received from backends over Fanout connections. |\n| fanout_conn_time_ms | integer | Total duration of Fanout connections with end users. |\n| fanout_recv_publishes | integer | Total published messages received from the publish API endpoint. |\n| fanout_req_body_bytes | integer | Total body or message content bytes received from end users over Fanout connections. |\n| fanout_req_header_bytes | integer | Total header bytes received from end users over Fanout connections. |\n| fanout_resp_body_bytes | integer | Total body or message content bytes sent to end users over Fanout connections, excluding published message content. |\n| fanout_resp_header_bytes | integer | Total header bytes sent to end users over Fanout connections. |\n| fanout_send_publishes | integer | Total published messages sent to end users. |\n| fetch_sub_count | integer | Number of executions of the vcl_fetch Varnish subroutine. |\n| fetch_sub_time | number | Time spent inside the vcl_fetch Varnish subroutine (in nanoseconds). |\n| hash_sub_count | integer | Number of executions of the vcl_hash Varnish subroutine. |\n| hash_sub_time | number | Time spent inside the vcl_hash Varnish subroutine (in nanoseconds). |\n| header_size | integer | Total header bytes delivered (alias for resp_header_bytes). |\n| hit_resp_body_bytes | integer | Total body bytes delivered for cache hits. |\n| hit_sub_count | integer | Number of executions of the vcl_hit Varnish subroutine. |\n| hit_sub_time | number | Time spent inside the vcl_hit Varnish subroutine (in nanoseconds). |\n| hits | integer | Number of cache hits. |\n| hits_time | number | Total amount of time spent processing cache hits (in seconds). |\n| http2 | integer | Number of requests received over HTTP/2. |\n| http3 | integer | Number of requests received over HTTP/3. |\n| imgopto | integer | Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed. |\n| imgopto_resp_body_bytes | integer | Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_resp_header_bytes | integer | Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_shield | integer | Number of responses that came from the Fastly Image Optimizer service via a shield. |\n| imgopto_shield_resp_body_bytes | integer | Total body bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_shield_resp_header_bytes | integer | Total header bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_transforms | integer | Number of transforms performed by the Fastly Image Optimizer service. |\n| imgvideo | integer | Number of video responses that came from the Fastly Image Optimizer service. |\n| imgvideo_frames | integer | Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_resp_body_bytes | integer | Total body bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_resp_header_bytes | integer | Total header bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_shield | integer | Number of video responses delivered via a shield that came from the Fastly Image Optimizer service. |\n| imgvideo_shield_frames | integer | Number of video frames delivered via a shield that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_shield_resp_body_bytes | integer | Total body bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| imgvideo_shield_resp_header_bytes | integer | Total header bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| ipv6 | integer | Number of requests that were received over IPv6. |\n| kv_store_class_a_operations | integer | The total number of class a operations for the KV store. |\n| kv_store_class_b_operations | integer | The total number of class b operations for the KV store. |\n| log | integer | Number of log lines sent. |\n| log_bytes | integer | Total log bytes sent. |\n| logging | integer | Number of log lines sent (alias for log). |\n| miss | integer | Number of cache misses. |\n| miss_histogram | object | A histogram. The value in each bucket is the number of requests to the origin whose responses arrived during the time period represented by the bucket. The key of each bucket represents the upper bound (in response time) of that bucket. The buckets vary in width and cover the time periods 0-10ms (in 1ms increments), 10-250ms (in 10ms increments), 250-1,000ms (in 50ms increments), 1,000-3,000ms (in 100ms increments), 3,000-10,000ms (in 500 ms increments), 10,000-20,000ms (in 1,000ms increments), 20,000-60,000ms (in 5,000ms increments), and 60,000ms through infinity (in a single bucket). |\n| miss_resp_body_bytes | integer | Total body bytes delivered for cache misses. |\n| miss_sub_count | integer | Number of executions of the vcl_miss Varnish subroutine. |\n| miss_sub_time | number | Time spent inside the vcl_miss Varnish subroutine (in nanoseconds). |\n| miss_time | number | Total amount of time spent processing cache misses (in seconds). |\n| object_size_100k | integer | Number of objects served that were between 10KB and 100KB in size. |\n| object_size_100m | integer | Number of objects served that were between 10MB and 100MB in size. |\n| object_size_10k | integer | Number of objects served that were between 1KB and 10KB in size. |\n| object_size_10m | integer | Number of objects served that were between 1MB and 10MB in size. |\n| object_size_1g | integer | Number of objects served that were between 100MB and 1GB in size. |\n| object_size_1k | integer | Number of objects served that were under 1KB in size. |\n| object_size_1m | integer | Number of objects served that were between 100KB and 1MB in size. |\n| object_size_other | integer | Number of objects served that were larger than 1GB in size. |\n| object_storage_class_a_operations_count | integer | A count of the number of Class A Object Storage operations. |\n| object_storage_class_b_operations_count | integer | A count of the number of Class B Object Storage operations. |\n| object_store_class_a_operations | integer | Use kv_store_class_a_operations. |\n| object_store_class_b_operations | integer | Use kv_store_class_b_operations. |\n| origin_cache_fetch_resp_body_bytes | integer | Body bytes received from origin for cacheable content. |\n| origin_cache_fetch_resp_header_bytes | integer | Header bytes received from an origin for cacheable content. |\n| origin_cache_fetches | integer | The total number of completed requests made to backends (origins) that returned cacheable content. |\n| origin_fetch_body_bytes | integer | Total request body bytes sent to origin. |\n| origin_fetch_header_bytes | integer | Total request header bytes sent to origin. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | number | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((edge_resp_body_bytes + edge_resp_header_bytes) - (origin_fetch_resp_body_bytes + origin_fetch_resp_header_bytes)) / (edge_resp_body_bytes + edge_resp_header_bytes). |\n| origin_revalidations | integer | Number of responses received from origin with a 304 status code in response to an If-Modified-Since or If-None-Match request. Under regular scenarios, a revalidation will imply a cache hit. However, if using Fastly Image Optimizer or segmented caching this may result in a cache miss. |\n| otfp | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_deliver_time | number | Total amount of time spent delivering a response from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| otfp_manifests | integer | Number of responses that were manifest files from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_body_bytes | integer | Total body bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_header_bytes | integer | Total header bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand via a shield. |\n| otfp_shield_resp_body_bytes | integer | Total body bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_header_bytes | integer | Total header bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_time | number | Total amount of time spent delivering a response via a shield from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| pass | integer | Number of requests that passed through the CDN without being cached. |\n| pass_resp_body_bytes | integer | Total body bytes delivered for cache passes. |\n| pass_sub_count | integer | Number of executions of the vcl_pass Varnish subroutine. |\n| pass_sub_time | number | Time spent inside the vcl_pass Varnish subroutine (in nanoseconds). |\n| pass_time | number | Total amount of time spent processing cache passes (in seconds). |\n| pci | integer | Number of responses with the PCI flag turned on. |\n| pipe_sub_count | integer | Number of executions of the vcl_pipe Varnish subroutine. |\n| pipe_sub_time | number | Time spent inside the vcl_pipe Varnish subroutine (in nanoseconds). |\n| predeliver_sub_count | integer | Number of executions of the vcl_predeliver Varnish subroutine. |\n| predeliver_sub_time | number | Time spent inside the vcl_predeliver Varnish subroutine (in nanoseconds). |\n| prehash_sub_count | integer | Number of executions of the vcl_prehash Varnish subroutine. |\n| prehash_sub_time | number | Time spent inside the vcl_prehash Varnish subroutine (in nanoseconds). |\n| recv_sub_count | integer | Number of executions of the vcl_recv Varnish subroutine. |\n| recv_sub_time | number | Time spent inside the vcl_recv Varnish subroutine (in nanoseconds). |\n| req_body_bytes | integer | Total body bytes received. |\n| req_header_bytes | integer | Total header bytes received. |\n| request_collapse_unusable_count | integer | Number of requests that were collapsed and unable to be satisfied by the resulting cache object. |\n| request_collapse_usable_count | integer | Number of requests that were collapsed and satisfied by a usable cache object. |\n| request_denied_get_head_body | integer | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered (edge_resp_body_bytes + shield_resp_body_bytes). |\n| resp_header_bytes | integer | Total header bytes delivered (edge_resp_header_bytes + shield_resp_header_bytes). |\n| restarts | integer | Number of restarts performed. |\n| segblock_origin_fetches | integer | Number of Range requests to origin for segments of resources when using segmented caching. |\n| segblock_shield_fetches | integer | Number of Range requests to a shield for segments of resources when using segmented caching. |\n| shield | integer | Number of requests from edge to the shield POP. |\n| shield_cache_fetches | integer | The total number of completed requests made to shields that returned cacheable content. |\n| shield_fetch_body_bytes | integer | Total request body bytes sent to a shield. |\n| shield_fetch_header_bytes | integer | Total request header bytes sent to a shield. |\n| shield_fetch_resp_body_bytes | integer | Total response body bytes sent from a shield to the edge. |\n| shield_fetch_resp_header_bytes | integer | Total response header bytes sent from a shield to the edge. |\n| shield_fetches | integer | Number of requests made from one Fastly POP to another, as part of shielding. |\n| shield_hit_requests | integer | Number of requests that resulted in a hit at a shield. |\n| shield_hit_resp_body_bytes | integer | Body bytes delivered for shield hits. |\n| shield_hit_resp_header_bytes | integer | Header bytes delivered for shield hits. |\n| shield_miss_requests | integer | Number of requests that resulted in a miss at a shield. |\n| shield_miss_resp_body_bytes | integer | Body bytes delivered for shield misses. |\n| shield_miss_resp_header_bytes | integer | Header bytes delivered for shield misses. |\n| shield_resp_body_bytes | integer | Total body bytes delivered via a shield. |\n| shield_resp_header_bytes | integer | Total header bytes delivered via a shield. |\n| shield_revalidations | integer | Number of responses received from origin with a 304 status code, in response to an If-Modified-Since or If-None-Match request to a shield. Under regular scenarios, a revalidation will imply a cache hit. However, if using segmented caching this may result in a cache miss. |\n| status_1xx | integer | Number of \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses sent with status code 200 (Success). |\n| status_204 | integer | Number of responses sent with status code 204 (No Content). |\n| status_206 | integer | Number of responses sent with status code 206 (Partial Content). |\n| status_2xx | integer | Number of \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses sent with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses sent with status code 302 (Found). |\n| status_304 | integer | Number of responses sent with status code 304 (Not Modified). |\n| status_3xx | integer | Number of \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses sent with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses sent with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses sent with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses sent with status code 404 (Not Found). |\n| status_406 | integer | Number of responses sent with status code 406 (Not Acceptable). |\n| status_416 | integer | Number of responses sent with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses sent with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses sent with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses sent with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses sent with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses sent with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses sent with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses sent with status code 505 (HTTP Version Not Supported). |\n| status_530 | integer | Number of responses sent with status code 530. |\n| status_5xx | integer | Number of \"Server Error\" codes delivered. |\n| synth | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement). |\n| tls | integer | Number of requests that were received over TLS. |\n| tls_v10 | integer | Number of requests received over TLS 1.0. |\n| tls_v11 | integer | Number of requests received over TLS 1.1. |\n| tls_v12 | integer | Number of requests received over TLS 1.2. |\n| tls_v13 | integer | Number of requests received over TLS 1.3. |\n| uncacheable | integer | Number of requests that were designated uncachable. |\n| video | integer | Number of responses with the video segment or video manifest MIME type (i.e., application/x-mpegurl, application/vnd.apple.mpegurl, application/f4m, application/dash+xml, application/vnd.ms-sstr+xml, ideo/mp2t, audio/aac, video/f4f, video/x-flv, video/mp4, audio/mp4). |\n| waf_blocked | integer | Number of requests that triggered a WAF rule and were blocked. |\n| waf_logged | integer | Number of requests that triggered a WAF rule and were logged. |\n| waf_passed | integer | Number of requests that triggered a WAF rule and were passed. |\n| websocket_bereq_body_bytes | integer | Total message content bytes sent to backends over passthrough WebSocket connections. |\n| websocket_bereq_header_bytes | integer | Total header bytes sent to backends over passthrough WebSocket connections. |\n| websocket_beresp_body_bytes | integer | Total message content bytes received from backends over passthrough WebSocket connections. |\n| websocket_beresp_header_bytes | integer | Total header bytes received from backends over passthrough WebSocket connections. |\n| websocket_conn_time_ms | integer | Total duration of passthrough WebSocket connections with end users. |\n| websocket_req_body_bytes | integer | Total message content bytes received from end users over passthrough WebSocket connections. |\n| websocket_req_header_bytes | integer | Total header bytes received from end users over passthrough WebSocket connections. |\n| websocket_resp_body_bytes | integer | Total message content bytes sent to end users over passthrough WebSocket connections. |\n| websocket_resp_header_bytes | integer | Total header bytes sent to end users over passthrough WebSocket connections. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Stats",
"item": [
{
"name": "Get stats for a service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/stats/summary?end_time&month&start_time&year",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"stats",
"summary"
],
"query": [
{
"key": "end_time",
"description": "Epoch timestamp. Limits the results returned."
},
{
"key": "month",
"description": "2-digit month."
},
{
"key": "start_time",
"description": "Epoch timestamp. Limits the results returned."
},
{
"key": "year",
"description": "4-digit year."
}
]
},
"description": "Get the stats from a service for a block of time. This lists all stats by PoP location, starting with AMS. This call requires parameters to select block of time to query. Use either a timestamp range (using start_time and end_time) or a specified month/year combo (using month and year).\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/stats/summary?end_time=1608560817&month=05&start_time=1608560817&year=2020?end_time&month&start_time&year",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"stats",
"summary"
],
"query": [
{
"key": "end_time",
"description": "Epoch timestamp. Limits the results returned."
},
{
"key": "month",
"description": "2-digit month."
},
{
"key": "start_time",
"description": "Epoch timestamp. Limits the results returned."
},
{
"key": "year",
"description": "4-digit year."
}
]
},
"description": "Get the stats from a service for a block of time. This lists all stats by PoP location, starting with AMS. This call requires parameters to select block of time to query. Use either a timestamp range (using start_time and end_time) or a specified month/year combo (using month and year).\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"stats\":{\"LHR\":{\"resp_header_bytes\":0,\"resp_body_bytes\":0,\"requests\":0,\"hits\":0,\"miss\":0,\"uncacheable\":0,\"restarts\":0,\"pass\":0,\"pass_time\":0,\"pipe\":0,\"synth\":0,\"hits_time\":0,\"miss_time\":0,\"status_1xx\":0,\"status_2xx\":0,\"status_3xx\":0,\"status_4xx\":0,\"status_5xx\":0,\"status_200\":0,\"status_204\":0,\"status_206\":0,\"status_301\":0,\"status_302\":0,\"status_304\":0,\"status_400\":0,\"status_401\":0,\"status_403\":0,\"status_404\":0,\"status_416\":0,\"status_429\":0,\"status_500\":0,\"status_501\":0,\"status_502\":0,\"status_503\":0,\"status_504\":0,\"status_505\":0,\"attack_req_header_bytes\":0,\"attack_req_body_bytes\":0,\"attack_logged_req_header_bytes\":0,\"attack_logged_req_body_bytes\":0,\"attack_blocked_req_header_bytes\":0,\"attack_blocked_req_body_bytes\":0,\"attack_passed_req_header_bytes\":0,\"attack_passed_req_body_bytes\":0,\"attack_resp_synth_bytes\":0,\"waf_blocked\":0,\"waf_logged\":0,\"waf_passed\":0,\"bereq_header_bytes\":0,\"bereq_body_bytes\":0,\"req_header_bytes\":0,\"req_body_bytes\":0,\"blacklist\":0,\"tls\":0,\"tls_v10\":0,\"tls_v11\":0,\"tls_v12\":0,\"tls_v13\":0,\"shield\":0,\"shield_resp_header_bytes\":0,\"shield_resp_body_bytes\":0,\"ipv6\":0,\"http2\":0,\"pci\":0,\"object_size_1k\":0,\"object_size_10k\":0,\"object_size_100k\":0,\"object_size_1m\":0,\"object_size_10m\":0,\"object_size_100m\":0,\"object_size_1g\":0,\"otfp\":0,\"otfp_resp_header_bytes\":0,\"otfp_resp_body_bytes\":0,\"otfp_shield_resp_header_bytes\":0,\"otfp_shield_resp_body_bytes\":0,\"otfp_manifests\":0,\"otfp_deliver_time\":0,\"otfp_shield_time\":0,\"imgopto\":0,\"imgopto_resp_header_bytes\":0,\"imgopto_resp_body_bytes\":0,\"imgopto_shield_resp_header_bytes\":0,\"imgopto_shield_resp_body_bytes\":0,\"video\":0,\"recv_sub_time\":0,\"recv_sub_count\":0,\"hash_sub_time\":0,\"hash_sub_count\":0,\"miss_sub_time\":0,\"miss_sub_count\":0,\"fetch_sub_time\":0,\"fetch_sub_count\":0,\"pass_sub_time\":0,\"pass_sub_count\":0,\"pipe_sub_time\":0,\"pipe_sub_count\":0,\"deliver_sub_time\":0,\"deliver_sub_count\":0,\"error_sub_time\":0,\"error_sub_count\":0,\"hit_sub_time\":0,\"hit_sub_count\":0,\"prehash_sub_time\":0,\"prehash_sub_count\":0,\"predeliver_sub_time\":0,\"predeliver_sub_count\":0,\"tls_handshake_sent_bytes\":0,\"hit_resp_body_bytes\":2232360,\"miss_resp_body_bytes\":2181748,\"pass_resp_body_bytes\":2242,\"log\":0,\"log_bytes\":0,\"edge_resp_header_bytes\":0,\"edge_resp_body_bytes\":0,\"origin_revalidations\":0,\"origin_fetches\":25,\"origin_fetch_header_bytes\":24821,\"origin_fetch_body_bytes\":464,\"origin_fetch_resp_header_bytes\":29434,\"origin_fetch_resp_body_bytes\":2183990,\"shield_revalidations\":0,\"shield_fetches\":0,\"shield_fetch_header_bytes\":0,\"shield_fetch_body_bytes\":0,\"shield_fetch_resp_header_bytes\":0,\"shield_fetch_resp_body_bytes\":0,\"segblock_origin_fetches\":0,\"segblock_shield_fetches\":0,\"origin_cache_fetches\":7,\"header_size\":0,\"body_size\":0,\"orig_req_header_size\":0,\"orig_req_body_size\":0,\"orig_resp_header_size\":0,\"orig_resp_body_size\":0,\"edge_requests\":0,\"errors\":0,\"compute_requests\":20,\"compute_request_time_ms\":9158.1,\"compute_request_time_billed_ms\":9400,\"compute_ram_used\":28835840,\"compute_execution_time_ms\":114.048,\"compute_req_header_bytes\":23478,\"compute_resp_header_bytes\":10850,\"compute_resp_body_bytes\":4414108,\"compute_resp_status_2xx\":16,\"compute_resp_status_3xx\":4,\"compute_bereq_header_bytes\":33916,\"compute_bereq_body_bytes\":464,\"compute_beresp_header_bytes\":35349,\"compute_beresp_body_bytes\":4415630}}}"
}
]
}
],
"description": "Stats give you information on the usage and performance of your Service. They can be requested by Service and over a particular time span. Stats are broken down per POP, giving you information on how your Services are being used across the world. There is now a more flexible, and fully featured Stats API available.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Origin metrics",
"item": [
{
"name": "Origin Inspector Historical API",
"item": [
{
"name": "Get historical origin data for a service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/metrics/origins/services/{{service_id}}?cursor&datacenter&downsample&end&group_by&host&limit&metric®ion&start",
"host": [
"{{fastly_url}}"
],
"path": [
"metrics",
"origins",
"services",
"{{service_id}}"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "datacenter",
"description": "Limit query to one or more specific POPs. Values should be comma-separated."
},
{
"key": "downsample",
"description": "Duration of sample windows."
},
{
"key": "end",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."
},
{
"key": "group_by",
"description": "Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=host will return one timeseries for every origin host, as a total across all POPs."
},
{
"key": "host",
"description": "Limit query to one or more specific origin hosts. Values should be comma-separated."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 200."
},
{
"key": "metric",
"description": "The metrics to retrieve. Multiple values should be comma-separated."
},
{
"key": "region",
"description": "Limit query to one or more specific geographic regions. Values should be comma-separated."
},
{
"key": "start",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."
}
]
},
"description": "Fetches historical origin metrics for a given Fastly service, optionally filtering and grouping the results by origin host, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/metrics/origins/services/SU1Z0isxPaozGVKXdv0eY?datacenter=SJC%2CSTP&downsample=hour&end=2020-08-02T00%3A00%3A00.000Z&group_by=host&host=origin_1%2Corigin_2&metric=resp_body_bytes%2Cstatus_2xx®ion=usa&start=2021-08-01T00%3A00%3A00.000Z?cursor&datacenter&downsample&end&group_by&host&limit&metric®ion&start",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"metrics",
"origins",
"services",
"SU1Z0isxPaozGVKXdv0eY"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "datacenter",
"description": "Limit query to one or more specific POPs. Values should be comma-separated."
},
{
"key": "downsample",
"description": "Duration of sample windows."
},
{
"key": "end",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."
},
{
"key": "group_by",
"description": "Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=host will return one timeseries for every origin host, as a total across all POPs."
},
{
"key": "host",
"description": "Limit query to one or more specific origin hosts. Values should be comma-separated."
},
{
"key": "limit",
"description": "Number of results per page. The maximum is 200."
},
{
"key": "metric",
"description": "The metrics to retrieve. Multiple values should be comma-separated."
},
{
"key": "region",
"description": "Limit query to one or more specific geographic regions. Values should be comma-separated."
},
{
"key": "start",
"description": "A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."
}
]
},
"description": "Fetches historical origin metrics for a given Fastly service, optionally filtering and grouping the results by origin host, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"dimensions\":{\"host\":\"origin_1\",\"region\":\"usa\",\"datacenter\":\"SJC\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":552256,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":12323,\"status_2xx\":34}]},{\"dimensions\":{\"host\":\"origin_2\",\"region\":\"usa\",\"datacenter\":\"STP\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":221,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":234,\"status_2xx\":34}]}],\"meta\":{\"start\":\"2021-08-01T00:00:00Z\",\"end\":\"2020-08-02T00:00:00Z\",\"downsample\":\"hour\",\"metric\":\"resp_body_bytes,status_2xx\",\"limit\":100,\"next_cursor\":\"VTBwRENqVTJXVmszUz\",\"sort\":\"host,region,datacenter\",\"group_by\":\"none\",\"filters\":{}},\"status\":\"success\"}"
}
]
}
],
"description": "Origin Inspector provides a JSON-formatted historical API for visibility into responses delivered from your origin servers to Fastly. The API offers a standardized set of data to report in minutely, hourly or daily granularity on every origin response, byte, and status code received by a specified service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| meta | object | Meta information about the scope of the query in a human readable format. |\n| msg | string | If the query was not successful, this will provide a string that explains why. |\n| status | string | Whether or not we were able to successfully execute the query. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n| datacenter | string | The POP from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across POPs. |\n| host | string | The origin host from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across origin hosts. |\n| region | string | The geographic region from which the edge responses in this data entry were delivered. If unspecified, results are aggregated across regions. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| all_latency_0_to_1ms | integer | Number of responses with latency between 0 and 1 millisecond received for origin requests made by all sources. |\n| all_latency_10000_to_60000ms | integer | Number of responses with latency between 10,000 and 60,000 milliseconds received for origin requests made by all sources. |\n| all_latency_1000_to_5000ms | integer | Number of responses with latency between 1,000 and 5,000 milliseconds received for origin requests made by all sources. |\n| all_latency_100_to_250ms | integer | Number of responses with latency between 100 and 250 milliseconds received for origin requests made by all sources. |\n| all_latency_10_to_50ms | integer | Number of responses with latency between 10 and 50 milliseconds received for origin requests made by all sources. |\n| all_latency_1_to_5ms | integer | Number of responses with latency between 1 and 5 milliseconds received for origin requests made by all sources. |\n| all_latency_250_to_500ms | integer | Number of responses with latency between 250 and 500 milliseconds received for origin requests made by all sources. |\n| all_latency_5000_to_10000ms | integer | Number of responses with latency between 5,000 and 10,000 milliseconds received for origin requests made by all sources. |\n| all_latency_500_to_1000ms | integer | Number of responses with latency between 500 and 1,000 milliseconds received for origin requests made by all sources. |\n| all_latency_50_to_100ms | integer | Number of responses with latency between 50 and 100 milliseconds received for origin requests made by all sources. |\n| all_latency_5_to_10ms | integer | Number of responses with latency between 5 and 10 milliseconds received for origin requests made by all sources. |\n| all_latency_60000ms | integer | Number of responses with latency of 60,000 milliseconds and above received for origin requests made by all sources. |\n| all_resp_body_bytes | integer | Number of body bytes received for origin requests made by all sources. |\n| all_resp_header_bytes | integer | Number of header bytes received for origin requests made by all sources. |\n| all_responses | integer | Number of responses received for origin requests made by all sources. |\n| all_status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered received for origin requests made by all sources. |\n| all_status_200 | integer | Number of responses received with status code 200 (Success) received for origin requests made by all sources. |\n| all_status_204 | integer | Number of responses received with status code 204 (No Content) received for origin requests made by all sources. |\n| all_status_206 | integer | Number of responses received with status code 206 (Partial Content) received for origin requests made by all sources. |\n| all_status_2xx | integer | Number of 2xx \"Success\" status codes received for origin requests made by all sources. |\n| all_status_301 | integer | Number of responses received with status code 301 (Moved Permanently) received for origin requests made by all sources. |\n| all_status_302 | integer | Number of responses received with status code 302 (Found) received for origin requests made by all sources. |\n| all_status_304 | integer | Number of responses received with status code 304 (Not Modified) received for origin requests made by all sources. |\n| all_status_3xx | integer | Number of 3xx \"Redirection\" codes received for origin requests made by all sources. |\n| all_status_400 | integer | Number of responses received with status code 400 (Bad Request) received for origin requests made by all sources. |\n| all_status_401 | integer | Number of responses received with status code 401 (Unauthorized) received for origin requests made by all sources. |\n| all_status_403 | integer | Number of responses received with status code 403 (Forbidden) received for origin requests made by all sources. |\n| all_status_404 | integer | Number of responses received with status code 404 (Not Found) received for origin requests made by all sources. |\n| all_status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) received for origin requests made by all sources. |\n| all_status_429 | integer | Number of responses received with status code 429 (Too Many Requests) received for origin requests made by all sources. |\n| all_status_4xx | integer | Number of 4xx \"Client Error\" codes received for origin requests made by all sources. |\n| all_status_500 | integer | Number of responses received with status code 500 (Internal Server Error) received for origin requests made by all sources. |\n| all_status_501 | integer | Number of responses received with status code 501 (Not Implemented) received for origin requests made by all sources. |\n| all_status_502 | integer | Number of responses received with status code 502 (Bad Gateway) received for origin requests made by all sources. |\n| all_status_503 | integer | Number of responses received with status code 503 (Service Unavailable) received for origin requests made by all sources. |\n| all_status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) received for origin requests made by all sources. |\n| all_status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) received for origin requests made by all sources. |\n| all_status_530 | integer | Number of responses received with status code 530 received for origin requests made by all sources. |\n| all_status_5xx | integer | Number of 5xx \"Server Error\" codes received for origin requests made by all sources. |\n| compute_latency_0_to_1ms | integer | Number of responses with latency between 0 and 1 millisecond for origin received by the Compute platform. |\n| compute_latency_10000_to_60000ms | integer | Number of responses with latency between 10,000 and 60,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_1000_to_5000ms | integer | Number of responses with latency between 1,000 and 5,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_100_to_250ms | integer | Number of responses with latency between 100 and 250 milliseconds for origin received by the Compute platform. |\n| compute_latency_10_to_50ms | integer | Number of responses with latency between 10 and 50 milliseconds for origin received by the Compute platform. |\n| compute_latency_1_to_5ms | integer | Number of responses with latency between 1 and 5 milliseconds for origin received by the Compute platform. |\n| compute_latency_250_to_500ms | integer | Number of responses with latency between 250 and 500 milliseconds for origin received by the Compute platform. |\n| compute_latency_5000_to_10000ms | integer | Number of responses with latency between 5,000 and 10,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_500_to_1000ms | integer | Number of responses with latency between 500 and 1,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_50_to_100ms | integer | Number of responses with latency between 50 and 100 milliseconds for origin received by the Compute platform. |\n| compute_latency_5_to_10ms | integer | Number of responses with latency between 5 and 10 milliseconds for origin received by the Compute platform. |\n| compute_latency_60000ms | integer | Number of responses with latency of 60,000 milliseconds and above for origin received by the Compute platform. |\n| compute_resp_body_bytes | integer | Number of body bytes for origin received by the Compute platform. |\n| compute_resp_header_bytes | integer | Number of header bytes for origin received by the Compute platform. |\n| compute_responses | integer | Number of responses for origin received by the Compute platform. |\n| compute_status_1xx | integer | Number of 1xx \"Informational\" status codes for origin received by the Compute platform. |\n| compute_status_200 | integer | Number of responses received with status code 200 (Success) for origin received by the Compute platform. |\n| compute_status_204 | integer | Number of responses received with status code 204 (No Content) for origin received by the Compute platform. |\n| compute_status_206 | integer | Number of responses received with status code 206 (Partial Content) for origin received by the Compute platform. |\n| compute_status_2xx | integer | Number of 2xx \"Success\" status codes for origin received by the Compute platform. |\n| compute_status_301 | integer | Number of responses received with status code 301 (Moved Permanently) for origin received by the Compute platform. |\n| compute_status_302 | integer | Number of responses received with status code 302 (Found) for origin received by the Compute platform. |\n| compute_status_304 | integer | Number of responses received with status code 304 (Not Modified) for origin received by the Compute platform. |\n| compute_status_3xx | integer | Number of 3xx \"Redirection\" codes for origin received by the Compute platform. |\n| compute_status_400 | integer | Number of responses received with status code 400 (Bad Request) for origin received by the Compute platform. |\n| compute_status_401 | integer | Number of responses received with status code 401 (Unauthorized) for origin received by the Compute platform. |\n| compute_status_403 | integer | Number of responses received with status code 403 (Forbidden) for origin received by the Compute platform. |\n| compute_status_404 | integer | Number of responses received with status code 404 (Not Found) for origin received by the Compute platform. |\n| compute_status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) for origin received by the Compute platform. |\n| compute_status_429 | integer | Number of responses received with status code 429 (Too Many Requests) for origin received by the Compute platform. |\n| compute_status_4xx | integer | Number of 4xx \"Client Error\" codes for origin received by the Compute platform. |\n| compute_status_500 | integer | Number of responses received with status code 500 (Internal Server Error) for origin received by the Compute platform. |\n| compute_status_501 | integer | Number of responses received with status code 501 (Not Implemented) for origin received by the Compute platform. |\n| compute_status_502 | integer | Number of responses received with status code 502 (Bad Gateway) for origin received by the Compute platform. |\n| compute_status_503 | integer | Number of responses received with status code 503 (Service Unavailable) for origin received by the Compute platform. |\n| compute_status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) for origin received by the Compute platform. |\n| compute_status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) for origin received by the Compute platform. |\n| compute_status_530 | integer | Number of responses received with status code 530 for origin received by the Compute platform. |\n| compute_status_5xx | integer | Number of 5xx \"Server Error\" codes for origin received by the Compute platform. |\n| latency_0_to_1ms | integer | Number of responses from origin with latency between 0 and 1 millisecond. |\n| latency_10000_to_60000ms | integer | Number of responses from origin with latency between 10,000 and 60,000 milliseconds. |\n| latency_1000_to_5000ms | integer | Number of responses from origin with latency between 1,000 and 5,000 milliseconds. |\n| latency_100_to_250ms | integer | Number of responses from origin with latency between 100 and 250 milliseconds. |\n| latency_10_to_50ms | integer | Number of responses from origin with latency between 10 and 50 milliseconds. |\n| latency_1_to_5ms | integer | Number of responses from origin with latency between 1 and 5 milliseconds. |\n| latency_250_to_500ms | integer | Number of responses from origin with latency between 250 and 500 milliseconds. |\n| latency_5000_to_10000ms | integer | Number of responses from origin with latency between 5,000 and 10,000 milliseconds. |\n| latency_500_to_1000ms | integer | Number of responses from origin with latency between 500 and 1,000 milliseconds. |\n| latency_50_to_100ms | integer | Number of responses from origin with latency between 50 and 100 milliseconds. |\n| latency_5_to_10ms | integer | Number of responses from origin with latency between 5 and 10 milliseconds. |\n| latency_60000ms | integer | Number of responses from origin with latency of 60,000 milliseconds and above. |\n| resp_body_bytes | integer | Number of body bytes from origin. |\n| resp_header_bytes | integer | Number of header bytes from origin. |\n| responses | integer | Number of responses from origin. |\n| status_1xx | integer | Number of 1xx \"Informational\" status codes delivered from origin. |\n| status_200 | integer | Number of responses received with status code 200 (Success) from origin. |\n| status_204 | integer | Number of responses received with status code 204 (No Content) from origin. |\n| status_206 | integer | Number of responses received with status code 206 (Partial Content) from origin. |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered from origin. |\n| status_301 | integer | Number of responses received with status code 301 (Moved Permanently) from origin. |\n| status_302 | integer | Number of responses received with status code 302 (Found) from origin. |\n| status_304 | integer | Number of responses received with status code 304 (Not Modified) from origin. |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered from origin. |\n| status_400 | integer | Number of responses received with status code 400 (Bad Request) from origin. |\n| status_401 | integer | Number of responses received with status code 401 (Unauthorized) from origin. |\n| status_403 | integer | Number of responses received with status code 403 (Forbidden) from origin. |\n| status_404 | integer | Number of responses received with status code 404 (Not Found) from origin. |\n| status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) from origin. |\n| status_429 | integer | Number of responses received with status code 429 (Too Many Requests) from origin. |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered from origin. |\n| status_500 | integer | Number of responses received with status code 500 (Internal Server Error) from origin. |\n| status_501 | integer | Number of responses received with status code 501 (Not Implemented) from origin. |\n| status_502 | integer | Number of responses received with status code 502 (Bad Gateway) from origin. |\n| status_503 | integer | Number of responses received with status code 503 (Service Unavailable) from origin. |\n| status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) from origin. |\n| status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) from origin. |\n| status_530 | integer | Number of responses received from origin with status code 530. |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered from origin. |\n| waf_latency_0_to_1ms | integer | Number of responses with latency between 0 and 1 millisecond received for origin requests made by the Fastly WAF. |\n| waf_latency_10000_to_60000ms | integer | Number of responses with latency between 10,000 and 60,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_1000_to_5000ms | integer | Number of responses with latency between 1,000 and 5,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_100_to_250ms | integer | Number of responses with latency between 100 and 250 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_10_to_50ms | integer | Number of responses with latency between 10 and 50 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_1_to_5ms | integer | Number of responses with latency between 1 and 5 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_250_to_500ms | integer | Number of responses with latency between 250 and 500 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_5000_to_10000ms | integer | Number of responses with latency between 5,000 and 10,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_500_to_1000ms | integer | Number of responses with latency between 500 and 1,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_50_to_100ms | integer | Number of responses with latency between 50 and 100 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_5_to_10ms | integer | Number of responses with latency between 5 and 10 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_60000ms | integer | Number of responses with latency of 60,000 milliseconds and above received for origin requests made by the Fastly WAF. |\n| waf_resp_body_bytes | integer | Number of body bytes received for origin requests made by the Fastly WAF. |\n| waf_resp_header_bytes | integer | Number of header bytes received for origin requests made by the Fastly WAF. |\n| waf_responses | integer | Number of responses received for origin requests made by the Fastly WAF. |\n| waf_status_1xx | integer | Number of 1xx \"Informational\" status codes received for origin requests made by the Fastly WAF. |\n| waf_status_200 | integer | Number of responses received with status code 200 (Success) received for origin requests made by the Fastly WAF. |\n| waf_status_204 | integer | Number of responses received with status code 204 (No Content) received for origin requests made by the Fastly WAF. |\n| waf_status_206 | integer | Number of responses received with status code 206 (Partial Content) received for origin requests made by the Fastly WAF. |\n| waf_status_2xx | integer | Number of 2xx \"Success\" status codes received for origin requests made by the Fastly WAF. |\n| waf_status_301 | integer | Number of responses received with status code 301 (Moved Permanently) received for origin requests made by the Fastly WAF. |\n| waf_status_302 | integer | Number of responses received with status code 302 (Found) received for origin requests made by the Fastly WAF. |\n| waf_status_304 | integer | Number of responses received with status code 304 (Not Modified) received for origin requests made by the Fastly WAF. |\n| waf_status_3xx | integer | Number of 3xx \"Redirection\" codes received for origin requests made by the Fastly WAF. |\n| waf_status_400 | integer | Number of responses received with status code 400 (Bad Request) received for origin requests made by the Fastly WAF. |\n| waf_status_401 | integer | Number of responses received with status code 401 (Unauthorized) received for origin requests made by the Fastly WAF. |\n| waf_status_403 | integer | Number of responses received with status code 403 (Forbidden) received for origin requests made by the Fastly WAF. |\n| waf_status_404 | integer | Number of responses received with status code 404 (Not Found) received for origin requests made by the Fastly WAF. |\n| waf_status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) received for origin requests made by the Fastly WAF. |\n| waf_status_429 | integer | Number of responses received with status code 429 (Too Many Requests) received for origin requests made by the Fastly WAF. |\n| waf_status_4xx | integer | Number of 4xx \"Client Error\" codes received for origin requests made by the Fastly WAF. |\n| waf_status_500 | integer | Number of responses received with status code 500 (Internal Server Error) received for origin requests made by the Fastly WAF. |\n| waf_status_501 | integer | Number of responses received with status code 501 (Not Implemented) received for origin requests made by the Fastly WAF. |\n| waf_status_502 | integer | Number of responses received with status code 502 (Bad Gateway) received for origin requests made by the Fastly WAF. |\n| waf_status_503 | integer | Number of responses received with status code 503 (Service Unavailable) received for origin requests made by the Fastly WAF. |\n| waf_status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) received for origin requests made by the Fastly WAF. |\n| waf_status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) received for origin requests made by the Fastly WAF. |\n| waf_status_530 | integer | Number of responses received with status code 530 received for origin requests made by the Fastly WAF. |\n| waf_status_5xx | integer | Number of 5xx \"Server Error\" codes received for origin requests made by the Fastly WAF. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Origin Inspector Real-time API",
"item": [
{
"name": "Get real-time origin data from specific time",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/origins/{{service_id}}/ts/{{start_timestamp}}",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"origins",
"{{service_id}}",
"ts",
"{{start_timestamp}}"
]
},
"description": "Get real-time origin data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/origins/SU1Z0isxPaozGVKXdv0eY/ts/1608560817",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"origins",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"1608560817"
]
},
"description": "Get real-time origin data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"STP\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}"
}
]
},
{
"name": "Get real-time origin data for the last 120 seconds",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/origins/{{service_id}}/ts/h",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"origins",
"{{service_id}}",
"ts",
"h"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/origins/SU1Z0isxPaozGVKXdv0eY/ts/h",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"origins",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"h"
]
},
"description": "Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"STP\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}"
}
]
},
{
"name": "Get a limited number of real-time origin data entries",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/v1/origins/{{service_id}}/ts/h/limit/{{max_entries}}",
"host": [
"{{fastly_url}}"
],
"path": [
"v1",
"origins",
"{{service_id}}",
"ts",
"h",
"limit",
"{{max_entries}}"
]
},
"description": "Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "rt.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/v1/origins/SU1Z0isxPaozGVKXdv0eY/ts/h/limit/1",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"v1",
"origins",
"SU1Z0isxPaozGVKXdv0eY",
"ts",
"h",
"limit",
"1"
]
},
"description": "Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"Data\":[{\"datacenter\":{\"STP\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}"
}
]
}
],
"description": "Origin Inspector offers a real-time JSON-formatted data stream providing visibility into responses delivered from your origin servers to Fastly. The API offers a standardized set of data to report in real-time every origin response, byte, and status code received by a specified service in one-second periods up to the last complete second.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| AggregateDelay | integer | Offset of entry timestamps from the current time due to processing time. |\n| Data | array | A list of report entries, each representing one second of time. |\n| Timestamp | integer | Value to use for subsequent requests. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| all_latency_0_to_1ms | integer | Number of responses with latency between 0 and 1 millisecond received for origin requests made by all sources. |\n| all_latency_10000_to_60000ms | integer | Number of responses with latency between 10,000 and 60,000 milliseconds received for origin requests made by all sources. |\n| all_latency_1000_to_5000ms | integer | Number of responses with latency between 1,000 and 5,000 milliseconds received for origin requests made by all sources. |\n| all_latency_100_to_250ms | integer | Number of responses with latency between 100 and 250 milliseconds received for origin requests made by all sources. |\n| all_latency_10_to_50ms | integer | Number of responses with latency between 10 and 50 milliseconds received for origin requests made by all sources. |\n| all_latency_1_to_5ms | integer | Number of responses with latency between 1 and 5 milliseconds received for origin requests made by all sources. |\n| all_latency_250_to_500ms | integer | Number of responses with latency between 250 and 500 milliseconds received for origin requests made by all sources. |\n| all_latency_5000_to_10000ms | integer | Number of responses with latency between 5,000 and 10,000 milliseconds received for origin requests made by all sources. |\n| all_latency_500_to_1000ms | integer | Number of responses with latency between 500 and 1,000 milliseconds received for origin requests made by all sources. |\n| all_latency_50_to_100ms | integer | Number of responses with latency between 50 and 100 milliseconds received for origin requests made by all sources. |\n| all_latency_5_to_10ms | integer | Number of responses with latency between 5 and 10 milliseconds received for origin requests made by all sources. |\n| all_latency_60000ms | integer | Number of responses with latency of 60,000 milliseconds and above received for origin requests made by all sources. |\n| all_resp_body_bytes | integer | Number of body bytes received for origin requests made by all sources. |\n| all_resp_header_bytes | integer | Number of header bytes received for origin requests made by all sources. |\n| all_responses | integer | Number of responses received for origin requests made by all sources. |\n| all_status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered received for origin requests made by all sources. |\n| all_status_200 | integer | Number of responses received with status code 200 (Success) received for origin requests made by all sources. |\n| all_status_204 | integer | Number of responses received with status code 204 (No Content) received for origin requests made by all sources. |\n| all_status_206 | integer | Number of responses received with status code 206 (Partial Content) received for origin requests made by all sources. |\n| all_status_2xx | integer | Number of 2xx \"Success\" status codes received for origin requests made by all sources. |\n| all_status_301 | integer | Number of responses received with status code 301 (Moved Permanently) received for origin requests made by all sources. |\n| all_status_302 | integer | Number of responses received with status code 302 (Found) received for origin requests made by all sources. |\n| all_status_304 | integer | Number of responses received with status code 304 (Not Modified) received for origin requests made by all sources. |\n| all_status_3xx | integer | Number of 3xx \"Redirection\" codes received for origin requests made by all sources. |\n| all_status_400 | integer | Number of responses received with status code 400 (Bad Request) received for origin requests made by all sources. |\n| all_status_401 | integer | Number of responses received with status code 401 (Unauthorized) received for origin requests made by all sources. |\n| all_status_403 | integer | Number of responses received with status code 403 (Forbidden) received for origin requests made by all sources. |\n| all_status_404 | integer | Number of responses received with status code 404 (Not Found) received for origin requests made by all sources. |\n| all_status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) received for origin requests made by all sources. |\n| all_status_429 | integer | Number of responses received with status code 429 (Too Many Requests) received for origin requests made by all sources. |\n| all_status_4xx | integer | Number of 4xx \"Client Error\" codes received for origin requests made by all sources. |\n| all_status_500 | integer | Number of responses received with status code 500 (Internal Server Error) received for origin requests made by all sources. |\n| all_status_501 | integer | Number of responses received with status code 501 (Not Implemented) received for origin requests made by all sources. |\n| all_status_502 | integer | Number of responses received with status code 502 (Bad Gateway) received for origin requests made by all sources. |\n| all_status_503 | integer | Number of responses received with status code 503 (Service Unavailable) received for origin requests made by all sources. |\n| all_status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) received for origin requests made by all sources. |\n| all_status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) received for origin requests made by all sources. |\n| all_status_530 | integer | Number of responses received with status code 530 received for origin requests made by all sources. |\n| all_status_5xx | integer | Number of 5xx \"Server Error\" codes received for origin requests made by all sources. |\n| compute_latency_0_to_1ms | integer | Number of responses with latency between 0 and 1 millisecond for origin received by the Compute platform. |\n| compute_latency_10000_to_60000ms | integer | Number of responses with latency between 10,000 and 60,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_1000_to_5000ms | integer | Number of responses with latency between 1,000 and 5,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_100_to_250ms | integer | Number of responses with latency between 100 and 250 milliseconds for origin received by the Compute platform. |\n| compute_latency_10_to_50ms | integer | Number of responses with latency between 10 and 50 milliseconds for origin received by the Compute platform. |\n| compute_latency_1_to_5ms | integer | Number of responses with latency between 1 and 5 milliseconds for origin received by the Compute platform. |\n| compute_latency_250_to_500ms | integer | Number of responses with latency between 250 and 500 milliseconds for origin received by the Compute platform. |\n| compute_latency_5000_to_10000ms | integer | Number of responses with latency between 5,000 and 10,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_500_to_1000ms | integer | Number of responses with latency between 500 and 1,000 milliseconds for origin received by the Compute platform. |\n| compute_latency_50_to_100ms | integer | Number of responses with latency between 50 and 100 milliseconds for origin received by the Compute platform. |\n| compute_latency_5_to_10ms | integer | Number of responses with latency between 5 and 10 milliseconds for origin received by the Compute platform. |\n| compute_latency_60000ms | integer | Number of responses with latency of 60,000 milliseconds and above for origin received by the Compute platform. |\n| compute_resp_body_bytes | integer | Number of body bytes for origin received by the Compute platform. |\n| compute_resp_header_bytes | integer | Number of header bytes for origin received by the Compute platform. |\n| compute_responses | integer | Number of responses for origin received by the Compute platform. |\n| compute_status_1xx | integer | Number of 1xx \"Informational\" status codes for origin received by the Compute platform. |\n| compute_status_200 | integer | Number of responses received with status code 200 (Success) for origin received by the Compute platform. |\n| compute_status_204 | integer | Number of responses received with status code 204 (No Content) for origin received by the Compute platform. |\n| compute_status_206 | integer | Number of responses received with status code 206 (Partial Content) for origin received by the Compute platform. |\n| compute_status_2xx | integer | Number of 2xx \"Success\" status codes for origin received by the Compute platform. |\n| compute_status_301 | integer | Number of responses received with status code 301 (Moved Permanently) for origin received by the Compute platform. |\n| compute_status_302 | integer | Number of responses received with status code 302 (Found) for origin received by the Compute platform. |\n| compute_status_304 | integer | Number of responses received with status code 304 (Not Modified) for origin received by the Compute platform. |\n| compute_status_3xx | integer | Number of 3xx \"Redirection\" codes for origin received by the Compute platform. |\n| compute_status_400 | integer | Number of responses received with status code 400 (Bad Request) for origin received by the Compute platform. |\n| compute_status_401 | integer | Number of responses received with status code 401 (Unauthorized) for origin received by the Compute platform. |\n| compute_status_403 | integer | Number of responses received with status code 403 (Forbidden) for origin received by the Compute platform. |\n| compute_status_404 | integer | Number of responses received with status code 404 (Not Found) for origin received by the Compute platform. |\n| compute_status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) for origin received by the Compute platform. |\n| compute_status_429 | integer | Number of responses received with status code 429 (Too Many Requests) for origin received by the Compute platform. |\n| compute_status_4xx | integer | Number of 4xx \"Client Error\" codes for origin received by the Compute platform. |\n| compute_status_500 | integer | Number of responses received with status code 500 (Internal Server Error) for origin received by the Compute platform. |\n| compute_status_501 | integer | Number of responses received with status code 501 (Not Implemented) for origin received by the Compute platform. |\n| compute_status_502 | integer | Number of responses received with status code 502 (Bad Gateway) for origin received by the Compute platform. |\n| compute_status_503 | integer | Number of responses received with status code 503 (Service Unavailable) for origin received by the Compute platform. |\n| compute_status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) for origin received by the Compute platform. |\n| compute_status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) for origin received by the Compute platform. |\n| compute_status_530 | integer | Number of responses received with status code 530 for origin received by the Compute platform. |\n| compute_status_5xx | integer | Number of 5xx \"Server Error\" codes for origin received by the Compute platform. |\n| latency_0_to_1ms | integer | Number of responses from origin with latency between 0 and 1 millisecond. |\n| latency_10000_to_60000ms | integer | Number of responses from origin with latency between 10,000 and 60,000 milliseconds. |\n| latency_1000_to_5000ms | integer | Number of responses from origin with latency between 1,000 and 5,000 milliseconds. |\n| latency_100_to_250ms | integer | Number of responses from origin with latency between 100 and 250 milliseconds. |\n| latency_10_to_50ms | integer | Number of responses from origin with latency between 10 and 50 milliseconds. |\n| latency_1_to_5ms | integer | Number of responses from origin with latency between 1 and 5 milliseconds. |\n| latency_250_to_500ms | integer | Number of responses from origin with latency between 250 and 500 milliseconds. |\n| latency_5000_to_10000ms | integer | Number of responses from origin with latency between 5,000 and 10,000 milliseconds. |\n| latency_500_to_1000ms | integer | Number of responses from origin with latency between 500 and 1,000 milliseconds. |\n| latency_50_to_100ms | integer | Number of responses from origin with latency between 50 and 100 milliseconds. |\n| latency_5_to_10ms | integer | Number of responses from origin with latency between 5 and 10 milliseconds. |\n| latency_60000ms | integer | Number of responses from origin with latency of 60,000 milliseconds and above. |\n| resp_body_bytes | integer | Number of body bytes from origin. |\n| resp_header_bytes | integer | Number of header bytes from origin. |\n| responses | integer | Number of responses from origin. |\n| status_1xx | integer | Number of 1xx \"Informational\" status codes delivered from origin. |\n| status_200 | integer | Number of responses received with status code 200 (Success) from origin. |\n| status_204 | integer | Number of responses received with status code 204 (No Content) from origin. |\n| status_206 | integer | Number of responses received with status code 206 (Partial Content) from origin. |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered from origin. |\n| status_301 | integer | Number of responses received with status code 301 (Moved Permanently) from origin. |\n| status_302 | integer | Number of responses received with status code 302 (Found) from origin. |\n| status_304 | integer | Number of responses received with status code 304 (Not Modified) from origin. |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered from origin. |\n| status_400 | integer | Number of responses received with status code 400 (Bad Request) from origin. |\n| status_401 | integer | Number of responses received with status code 401 (Unauthorized) from origin. |\n| status_403 | integer | Number of responses received with status code 403 (Forbidden) from origin. |\n| status_404 | integer | Number of responses received with status code 404 (Not Found) from origin. |\n| status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) from origin. |\n| status_429 | integer | Number of responses received with status code 429 (Too Many Requests) from origin. |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered from origin. |\n| status_500 | integer | Number of responses received with status code 500 (Internal Server Error) from origin. |\n| status_501 | integer | Number of responses received with status code 501 (Not Implemented) from origin. |\n| status_502 | integer | Number of responses received with status code 502 (Bad Gateway) from origin. |\n| status_503 | integer | Number of responses received with status code 503 (Service Unavailable) from origin. |\n| status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) from origin. |\n| status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) from origin. |\n| status_530 | integer | Number of responses received from origin with status code 530. |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered from origin. |\n| waf_latency_0_to_1ms | integer | Number of responses with latency between 0 and 1 millisecond received for origin requests made by the Fastly WAF. |\n| waf_latency_10000_to_60000ms | integer | Number of responses with latency between 10,000 and 60,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_1000_to_5000ms | integer | Number of responses with latency between 1,000 and 5,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_100_to_250ms | integer | Number of responses with latency between 100 and 250 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_10_to_50ms | integer | Number of responses with latency between 10 and 50 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_1_to_5ms | integer | Number of responses with latency between 1 and 5 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_250_to_500ms | integer | Number of responses with latency between 250 and 500 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_5000_to_10000ms | integer | Number of responses with latency between 5,000 and 10,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_500_to_1000ms | integer | Number of responses with latency between 500 and 1,000 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_50_to_100ms | integer | Number of responses with latency between 50 and 100 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_5_to_10ms | integer | Number of responses with latency between 5 and 10 milliseconds received for origin requests made by the Fastly WAF. |\n| waf_latency_60000ms | integer | Number of responses with latency of 60,000 milliseconds and above received for origin requests made by the Fastly WAF. |\n| waf_resp_body_bytes | integer | Number of body bytes received for origin requests made by the Fastly WAF. |\n| waf_resp_header_bytes | integer | Number of header bytes received for origin requests made by the Fastly WAF. |\n| waf_responses | integer | Number of responses received for origin requests made by the Fastly WAF. |\n| waf_status_1xx | integer | Number of 1xx \"Informational\" status codes received for origin requests made by the Fastly WAF. |\n| waf_status_200 | integer | Number of responses received with status code 200 (Success) received for origin requests made by the Fastly WAF. |\n| waf_status_204 | integer | Number of responses received with status code 204 (No Content) received for origin requests made by the Fastly WAF. |\n| waf_status_206 | integer | Number of responses received with status code 206 (Partial Content) received for origin requests made by the Fastly WAF. |\n| waf_status_2xx | integer | Number of 2xx \"Success\" status codes received for origin requests made by the Fastly WAF. |\n| waf_status_301 | integer | Number of responses received with status code 301 (Moved Permanently) received for origin requests made by the Fastly WAF. |\n| waf_status_302 | integer | Number of responses received with status code 302 (Found) received for origin requests made by the Fastly WAF. |\n| waf_status_304 | integer | Number of responses received with status code 304 (Not Modified) received for origin requests made by the Fastly WAF. |\n| waf_status_3xx | integer | Number of 3xx \"Redirection\" codes received for origin requests made by the Fastly WAF. |\n| waf_status_400 | integer | Number of responses received with status code 400 (Bad Request) received for origin requests made by the Fastly WAF. |\n| waf_status_401 | integer | Number of responses received with status code 401 (Unauthorized) received for origin requests made by the Fastly WAF. |\n| waf_status_403 | integer | Number of responses received with status code 403 (Forbidden) received for origin requests made by the Fastly WAF. |\n| waf_status_404 | integer | Number of responses received with status code 404 (Not Found) received for origin requests made by the Fastly WAF. |\n| waf_status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) received for origin requests made by the Fastly WAF. |\n| waf_status_429 | integer | Number of responses received with status code 429 (Too Many Requests) received for origin requests made by the Fastly WAF. |\n| waf_status_4xx | integer | Number of 4xx \"Client Error\" codes received for origin requests made by the Fastly WAF. |\n| waf_status_500 | integer | Number of responses received with status code 500 (Internal Server Error) received for origin requests made by the Fastly WAF. |\n| waf_status_501 | integer | Number of responses received with status code 501 (Not Implemented) received for origin requests made by the Fastly WAF. |\n| waf_status_502 | integer | Number of responses received with status code 502 (Bad Gateway) received for origin requests made by the Fastly WAF. |\n| waf_status_503 | integer | Number of responses received with status code 503 (Service Unavailable) received for origin requests made by the Fastly WAF. |\n| waf_status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) received for origin requests made by the Fastly WAF. |\n| waf_status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) received for origin requests made by the Fastly WAF. |\n| waf_status_530 | integer | Number of responses received with status code 530 received for origin requests made by the Fastly WAF. |\n| waf_status_5xx | integer | Number of 5xx \"Server Error\" codes received for origin requests made by the Fastly WAF. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aggregated | object | Groups measurements by backend name. |\n| datacenter | object | Groups measurements by POP, then backend name. See the POPs API for details about POP identifiers. |\n| recorded | integer | The Unix timestamp at which this record's data was generated. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Alerts",
"item": [
{
"name": "Definitions",
"item": [
{
"name": "List definitions",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/alerts/definitions?cursor&integration_id&limit&name&service_id&sort",
"host": [
"{{fastly_url}}"
],
"path": [
"alerts",
"definitions"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "integration_id",
"description": "Filter definitions by integration."
},
{
"key": "limit",
"description": "Limit how many results are returned."
},
{
"key": "name",
"description": "Filter definitions by name."
},
{
"key": "service_id",
"description": "Filter results based on a service_id."
},
{
"key": "sort",
"description": "Sort the items by field provided ascending or descending."
}
]
},
"description": "List all definitions for a particular customer. Definitions can be filtered by name, service_id, and integration_id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 Listing all definitions",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/alerts/definitions?cursor&integration_id&limit&name&service_id&sort",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"alerts",
"definitions"
],
"query": [
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "integration_id",
"description": "Filter definitions by integration."
},
{
"key": "limit",
"description": "Limit how many results are returned."
},
{
"key": "name",
"description": "Filter definitions by name."
},
{
"key": "service_id",
"description": "Filter results based on a service_id."
},
{
"key": "sort",
"description": "Sort the items by field provided ascending or descending."
}
]
},
"description": "List all definitions for a particular customer. Definitions can be filtered by name, service_id, and integration_id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 Listing all definitions",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"x4xCwxxJxGCx123Rx5xTx\",\"object\":\"definition\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"],\"created_at\":\"2022-09-14T19:06:27Z\",\"updated_at\":\"2022-09-14T19:06:27Z\"},{\"id\":\"x4xCwxxJxGCx123Rx5xTx\",\"object\":\"definition\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on domain\",\"description\":\"A description of your alert\",\"dimensions\":{\"domains\":[\"example-domain.com\"]},\"metric\":\"status_5xx\",\"source\":\"domains\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"],\"created_at\":\"2022-09-14T19:06:27Z\",\"updated_at\":\"2022-09-14T19:06:27Z\"},{\"id\":\"x4xCwxxJxGCx123Rx5xTx\",\"object\":\"definition\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on stats\",\"description\":\"A description of your alert\",\"dimensions\":{},\"metric\":\"status_5xx\",\"source\":\"stats\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"],\"created_at\":\"2022-09-14T19:06:27Z\",\"updated_at\":\"2022-09-14T19:06:27Z\"}],\"meta\":{\"next_cursor\":\"\",\"limit\":100,\"sort\":\"-created_at\",\"total\":3}}"
}
]
},
{
"name": "Create definition",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"]}"
},
"url": {
"raw": "{{fastly_url}}/alerts/definitions",
"host": [
"{{fastly_url}}"
],
"path": [
"alerts",
"definitions"
]
},
"description": "Create a definition for a particular customer based on metrics.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "201 Requested definition",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"]}"
},
"url": {
"raw": "https://api.fastly.com/alerts/definitions",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"alerts",
"definitions"
]
},
"description": "Create a definition for a particular customer based on metrics.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "201 Requested definition",
"code": 201,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"x4xCwxxJxGCx123Rx5xTx\",\"object\":\"definition\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"],\"created_at\":\"2022-09-14T19:06:27Z\",\"updated_at\":\"2022-09-14T19:06:27Z\"}"
}
]
},
{
"name": "Read definition",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/alerts/definitions/{{definition_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"alerts",
"definitions",
"{{definition_id}}"
]
},
"description": "Retrieve an existing definition by using its ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 Requested definition",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/alerts/definitions/{{definition_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"alerts",
"definitions",
"{{definition_id}}"
]
},
"description": "Retrieve an existing definition by using its ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 Requested definition",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"x4xCwxxJxGCx123Rx5xTx\",\"object\":\"definition\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"],\"created_at\":\"2022-09-14T19:06:27Z\",\"updated_at\":\"2022-09-14T19:06:27Z\"}"
}
]
},
{
"name": "Update definition",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"]}"
},
"url": {
"raw": "{{fastly_url}}/alerts/definitions/{{definition_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"alerts",
"definitions",
"{{definition_id}}"
]
},
"description": "Update a definition with a new configuration.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 Update was successful",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"]}"
},
"url": {
"raw": "https://api.fastly.com/alerts/definitions/{{definition_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"alerts",
"definitions",
"{{definition_id}}"
]
},
"description": "Update a definition with a new configuration.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 Update was successful",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Delete definition",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/alerts/definitions/{{definition_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"alerts",
"definitions",
"{{definition_id}}"
]
},
"description": "Delete a definition using its ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "204 Delete was successful",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/alerts/definitions/{{definition_id}}",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"alerts",
"definitions",
"{{definition_id}}"
]
},
"description": "Delete a definition using its ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "204 Delete was successful",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
}
],
"description": "Definitions are used to configure alerts on how to observe a metric.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| created_at | string | Time when the definition was created (RFC3339). |\n| description | string | Additional text that is included in the alert notification. |\n| dimensions | object | More filters depending on the source type. |\n| evaluation_strategy | object | Criteria on how to alert. |\n| id | string | A unique identifier for a definition. |\n| integration_ids | array | List of integrations used to notify when alert fires. Refer to Notification Service. |\n| metric | string | The metric name to alert on for a specific source:\ndomains,\norigins or\nstats. |\n| name | string | The name of the alert definition. |\n| object | string | The resource type. |\n| service_id | string | The service on which the definition will alert on. |\n| source | string | The source where the metric comes from. |\n| updated_at | string | Time when the definition was last updated (RFC3339). |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| origin_offload_bytes | number | The number of bytes offloaded to the edge. |\n| status_404_rate | number | Fraction of responses with 404 codes delivered. If there are no responses, this value will be 0. |\n| status_4xx_excl_404_rate | number | Fraction of responses with non-404 4xx codes delivered. If there are no responses, this value will be 0. |\n| status_4xx_rate | number | Fraction of responses with 4xx codes delivered from domain. If there are no responses, this value will be 0. |\n| status_5xx_rate | number | Fraction of responses with 5xx codes delivered from domain. If there are no responses, this value will be 0. |\n| status_gte_400_rate | number | Fraction of responses with 4xx or 5xx codes delivered from domain. If there are no responses, this value will be 0. |\n| status_lt_500_rate | number | Fraction of responses with non-5xx codes delivered from domain. If there are no responses, this value will be 0. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| all_bandwidth | integer | The amount of bandwidth from your origin. |\n| all_status_404_rate | number | Fraction of all responses with 404 codes delivered (Compute, WAF, and VCL). If there are no responses, this value will be 0. |\n| all_status_4xx_excl_404_rate | number | Fraction of all responses with non-404 4xx codes delivered (Compute, WAF, and VCL). If there are no responses, this value will be 0. |\n| all_status_4xx_rate | number | Fraction of all responses with 4xx codes delivered (Compute, WAF, and VCL). If there are no responses, this value will be 0. |\n| all_status_5xx_rate | number | Fraction of all responses with 5xx codes delivered (Compute, WAF, and VCL). If there are no responses, this value will be 0. |\n| all_status_gte_400_rate | number | Fraction of all responses with 4xx or 5xx codes delivered (Compute, WAF, and VCL). If there are no responses, this value will be 0. |\n| all_status_lt_500_rate | number | Fraction of all responses with non-5xx codes delivered (Compute, WAF, and VCL). If there are no responses, this value will be 0. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| ignore_below | number | Threshold for the denominator value used in evaluations that calculate a rate or ratio. Usually used to filter out noise. |\n| period | string | The length of time to evaluate whether the conditions have been met. The data is polled every minute. |\n| threshold | number | Threshold used to alert. |\n| type | string | Type of strategy to use to evaluate. |\n| | above_threshold | This alert will fire when the observed metric goes above the specified threshold during an evaluation period at any one minute polling interval. The alert will resolve when there are zero one minute intervals in the evaluation period that exceed the threshold. |\n| | all_above_threshold | This alert will fire when the observed metric is above the specified threshold during an evaluation period for every one minute polling interval. The alert will resolve when there is one minute interval in the evaluation period that does not exceed the threshold. |\n| | below_threshold | This alert will fire when the observed metric remains below the specified threshold for two consecutive minutes in an evaluation period. The alert will resolve when there aren't two consecutive minutes in an evaluation period that are below the threshold. |\n| | percent_absolute | This alert will fire when the observed metric increases or decreases by more than a threshold percentage from the first to the last minute of the evaluation period. The alert will resolve when the percentage change is below the threshold. |\n| | percent_decrease | This alert will fire when the observed metric decreases by more than a threshold percentage from the first to the last minute of the evaluation period. The alert will resolve when the percentage decrease is below the threshold. |\n| | percent_increase | This alert will fire when the observed metric increases by more than a threshold percentage from the first to the last minute of the evaluation period. The alert will resolve when the percentage increase is below the threshold. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| all_status_4xx_rate | number | Fraction of all responses with 4xx codes delivered (Compute and VCL). If there are no responses, this value will be 0. |\n| all_status_5xx_rate | number | Fraction of all responses with 5xx codes delivered (Compute and VCL). If there are no responses, this value will be 0. |\n| all_status_gte_400_rate | number | Fraction of all responses with 4xx or 5xx codes delivered (Compute and VCL). If there are no responses, this value will be 0. |\n| all_status_lt_500_rate | number | Fraction of all responses with non-5xx codes delivered (Compute and VCL). If there are no responses, this value will be 0. |\n| status_404_rate | number | Fraction of VCL responses with 404 codes delivered. If there are no responses, this value will be 0. |\n| status_4xx_excl_404_rate | number | Fraction of VCL responses with non-404 4xx codes delivered. If there are no responses, this value will be 0. |\n| status_4xx_rate | number | Fraction of VCL responses with 4xx codes delivered. If there are no responses, this value will be 0. |\n| status_5xx_rate | number | Fraction of VCL responses with 5xx codes delivered. If there are no responses, this value will be 0. |\n| status_gte_400_rate | number | Fraction of VCL responses with 4xx or 5xx codes delivered. If there are no responses, this value will be 0. |\n| status_lt_500_rate | number | Fraction of VCL responses with non-5xx codes delivered. If there are no responses, this value will be 0. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "History",
"item": [
{
"name": "List history",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/alerts/history?after&before&cursor&definition_id&limit&service_id&sort&status",
"host": [
"{{fastly_url}}"
],
"path": [
"alerts",
"history"
],
"query": [
{
"key": "after",
"description": "Filter results based on records that were created after a specific time."
},
{
"key": "before",
"description": "Filter results based on records that were created before a specific time."
},
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "definition_id",
"description": "The ID of the definition that is requested."
},
{
"key": "limit",
"description": "Limit how many results are returned."
},
{
"key": "service_id",
"description": "Filter results based on a service_id."
},
{
"key": "sort",
"description": "Sort the items by the field provided, either ascending or descending."
},
{
"key": "status",
"description": "Filter results based on a status."
}
]
},
"description": "List all history records.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"response": [
{
"name": "200 Requested history",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/alerts/history?after&before&cursor&definition_id&limit&service_id&sort&status",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"alerts",
"history"
],
"query": [
{
"key": "after",
"description": "Filter results based on records that were created after a specific time."
},
{
"key": "before",
"description": "Filter results based on records that were created before a specific time."
},
{
"key": "cursor",
"description": "Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty."
},
{
"key": "definition_id",
"description": "The ID of the definition that is requested."
},
{
"key": "limit",
"description": "Limit how many results are returned."
},
{
"key": "service_id",
"description": "Filter results based on a service_id."
},
{
"key": "sort",
"description": "Sort the items by the field provided, either ascending or descending."
},
{
"key": "status",
"description": "Filter results based on a status."
}
]
},
"description": "List all history records.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n"
},
"status": "200 Requested history",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"6HW4welznAHVnMCJhY9QdX\",\"object\":\"history\",\"definition\":{\"id\":\"x4xCwxxJxGCx123Rx5xTx\",\"object\":\"definition\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"New alert on origin\",\"description\":\"A description of your alert\",\"dimensions\":{\"origins\":[\"example-origin.com\"]},\"metric\":\"all_status_5xx\",\"source\":\"origins\",\"evaluation_strategy\":{\"type\":\"above_threshold\",\"period\":\"5m\",\"threshold\":10},\"integration_ids\":[\"12pkXDutPjb9DI8JNYNm5q\"],\"created_at\":\"2022-09-14T19:06:27Z\",\"updated_at\":\"2022-09-14T19:06:27Z\"},\"definition_id\\\"\":\"x4xCwxxJxGCx123Rx5xTx\",\"start\":\"2022-09-14T20:06:27Z\",\"end\":\"2022-09-14T21:06:27Z\",\"status\":\"active\"}],\"meta\":{\"next_cursor\":\"\",\"limit\":100,\"sort\":\"-start\",\"total\":1}}"
}
]
}
],
"description": "Alerts history presents the past event notifications sent when observed metrics thresholds were triggered.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| definition | object | A snapshot of the definition. |\n| definition_id | string | Definition ID of which the event relates to. |\n| end | string | Time when the event ended (RFC3339). |\n| id | string | History ID for a given event. |\n| object | string | Type of resource this object is. |\n| start | string | Time when the event started (RFC3339). |\n| status | string | Status of the event. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Observability",
"item": [
{
"name": "Custom dashboards",
"item": [
{
"name": "List all custom dashboards",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/observability/dashboards",
"host": [
"{{fastly_url}}"
],
"path": [
"observability",
"dashboards"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#list-dashboards)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 List all custom dashboards",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/observability/dashboards",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"observability",
"dashboards"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#list-dashboards)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 List all custom dashboards",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"data\":[{\"id\":\"6zCMWp5NxFyHX1VdKiptmH\",\"name\":\"My Empty Dashboard\",\"description\":\"\",\"items\":[]},{\"id\":\"2eGFXF4F4kTxd4gU39Bg3e\",\"name\":\"My Cool Dashboard\",\"description\":\"This dashboard has one chart\",\"items\":[{\"id\":\"1qWQVbYqKAYJAsjFqr9EE6\",\"span\":4,\"title\":\"My Chart\",\"subtitle\":\"This chart displays my cool metrics\",\"data_source\":{\"type\":\"stats.edge\",\"config\":{\"metrics\":[\"requests\"]}},\"visualization\":{\"type\":\"chart\",\"config\":{\"plot_type\":\"line\",\"format\":\"number\"}}}],\"created_by\":\"x9KzsrACXZv8tPwlEDsKb6\",\"updated_by\":\"2Pgj3VqoQ8Zp57TWqt4VUb\",\"created_at\":\"2024-04-29T03:00:00.000Z\",\"updated_at\":\"2024-04-29T03:00:00.000Z\"}],\"meta\":{\"next_cursor\":\"\",\"limit\":20,\"sort\":\"-updated_at\",\"total\":2}}"
}
]
},
{
"name": "Create a new dashboard",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"My Empty Dashboard\"}"
},
"url": {
"raw": "{{fastly_url}}/observability/dashboards",
"host": [
"{{fastly_url}}"
],
"path": [
"observability",
"dashboards"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#create-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 Requested dashboard",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"My Empty Dashboard\"}"
},
"url": {
"raw": "https://api.fastly.com/observability/dashboards",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"observability",
"dashboards"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#create-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 Requested dashboard",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6zCMWp5NxFyHX1VdKiptmH\",\"name\":\"My Empty Dashboard\",\"description\":\"\",\"items\":[]}"
}
]
},
{
"name": "Retrieve a dashboard by ID",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/observability/dashboards/{{dashboard_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"observability",
"dashboards",
"{{dashboard_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#get-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 Requested dashboard",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/observability/dashboards/2eGFXF4F4kTxd4gU39Bg3e",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"observability",
"dashboards",
"2eGFXF4F4kTxd4gU39Bg3e"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#get-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 Requested dashboard",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"2eGFXF4F4kTxd4gU39Bg3e\",\"name\":\"My Cool Dashboard\",\"description\":\"This dashboard has one chart\",\"items\":[{\"id\":\"1qWQVbYqKAYJAsjFqr9EE6\",\"span\":4,\"title\":\"My Chart\",\"subtitle\":\"This chart displays my cool metrics\",\"data_source\":{\"type\":\"stats.edge\",\"config\":{\"metrics\":[\"requests\"]}},\"visualization\":{\"type\":\"chart\",\"config\":{\"plot_type\":\"line\",\"format\":\"number\"}}}],\"created_by\":\"x9KzsrACXZv8tPwlEDsKb6\",\"updated_by\":\"2Pgj3VqoQ8Zp57TWqt4VUb\",\"created_at\":\"2024-04-29T03:00:00.000Z\",\"updated_at\":\"2024-04-29T03:00:00.000Z\"}"
}
]
},
{
"name": "Delete an existing dashboard",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "{{fastly_url}}/observability/dashboards/{{dashboard_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"observability",
"dashboards",
"{{dashboard_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#delete-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "204 No Content",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
}
],
"url": {
"raw": "https://api.fastly.com/observability/dashboards/2eGFXF4F4kTxd4gU39Bg3e",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"observability",
"dashboards",
"2eGFXF4F4kTxd4gU39Bg3e"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#delete-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "204 No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": null
}
]
},
{
"name": "Update an existing dashboard",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"My Updated Dashboard\",\"description\":\"I'm altering the dashboard.\"}"
},
"url": {
"raw": "{{fastly_url}}/observability/dashboards/{{dashboard_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"observability",
"dashboards",
"{{dashboard_id}}"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#update-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 Update was successful",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\"name\":\"My Updated Dashboard\",\"description\":\"I'm altering the dashboard.\"}"
},
"url": {
"raw": "https://api.fastly.com/observability/dashboards/2eGFXF4F4kTxd4gU39Bg3e",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"observability",
"dashboards",
"2eGFXF4F4kTxd4gU39Bg3e"
]
},
"description": "**[🔗 latest documentation](https://developer.fastly.com/reference/api/observability/custom-dashboards/#update-dashboard)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 Update was successful",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"2eGFXF4F4kTxd4gU39Bg3e\",\"name\":\"My Updated Dashboard\",\"description\":\"I'm altering the dashboard.\",\"items\":[{\"id\":\"1qWQVbYqKAYJAsjFqr9EE6\",\"span\":4,\"title\":\"My Chart\",\"subtitle\":\"This chart displays my cool metrics\",\"data_source\":{\"type\":\"stats.edge\",\"config\":{\"metrics\":[\"requests\"]}},\"visualization\":{\"type\":\"chart\",\"config\":{\"plot_type\":\"line\",\"format\":\"number\"}}}],\"created_by\":\"x9KzsrACXZv8tPwlEDsKb6\",\"updated_by\":\"2Pgj3VqoQ8Zp57TWqt4VUb\",\"created_at\":\"2024-04-29T03:00:00.000Z\",\"updated_at\":\"2024-09-30T03:31:00.000Z\"}"
}
]
}
],
"description": "The Observability API allows you to programmatically define custom dashboards to view in the Observability web interface.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| description | string | A short description of the dashboard. |\n| items | array | A list of dashboard items. |\n| name | string | A human-readable name. |\n| created_at | string | Date and time in ISO 8601 format. |\n| created_by | string | The ID of the user who created the dashboard. |\n| id | string | Dashboard identifier (UUID). |\n| updated_at | string | Date and time in ISO 8601 format. |\n| updated_by | string | The ID of the user who last modified the dashboard. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| data_source | object | An object which describes the data to display. |\n| id | string | Dashboard item identifier (UUID). |\n| span | integer | The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on \"desktop\" screen sizes. |\n| subtitle | string | A human-readable subtitle for the dashboard item. Often a description of the visualization. |\n| title | string | A human-readable title for the dashboard item. |\n| visualization | object | An object which describes the data visualization to display. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| config | object | Configuration options for the selected data source. |\n| type | string | The source of the data to display. |\n| | stats.edge | Edge metrics. |\n| | stats.domain | Domain metrics. |\n| | stats.origin | Origin metrics. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| metrics | array | The metrics to visualize. Valid options are defined by the selected data source. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| config | object | Configuration options for the given visualization. |\n| type | string | The type of visualization to display. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| calculation_method | string | (Optional) The aggregation function to apply to the dataset. |\n| format | string | (Optional) The units to use to format the data. |\n| plot_type | string | The type of chart to display. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Insights",
"item": [
{
"name": "Retrieve log insights",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/observability/log-insights?domain_exact_match&domain&end&limit&pops&service_id&start&visualization",
"host": [
"{{fastly_url}}"
],
"path": [
"observability",
"log-insights"
],
"query": [
{
"key": "domain_exact_match",
"description": "Determines whether the value in the domain parameter should be treated as a suffix or exact match. When false for suffix match, any request domain ending in the specified value will be considered a match (e.g., foo.com will match a.foo.com and b.foo.com in addition to foo.com). Defaults to true for exact match."
},
{
"key": "domain",
"description": "Limits data to the specified request domain. Defaults to all request domains."
},
{
"key": "end",
"description": "Specifies the exclusive end time of the logs to be queried. Must be in valid RFC 3339 format."
},
{
"key": "limit",
"description": "Maximum number of rows to return. Defaults to 10, limited to 100."
},
{
"key": "pops",
"description": "Comma-separated list of Fastly POP codes. Omission defaults to all POPs."
},
{
"key": "service_id",
"description": "Specifies the ID of the service for which data should be returned."
},
{
"key": "start",
"description": "Specifies the inclusive start time of the logs to be queried. Must be in valid RFC 3339 format."
},
{
"key": "visualization",
"description": "Specifies the Log Insights visualization for which data should be returned."
}
]
},
"description": "Retrieves statistics from sampled log records.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 Retrieves log insights for the specified service and visualization.",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/observability/log-insights?domain_exact_match&domain&end&limit&pops&service_id&start&visualization",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"observability",
"log-insights"
],
"query": [
{
"key": "domain_exact_match",
"description": "Determines whether the value in the domain parameter should be treated as a suffix or exact match. When false for suffix match, any request domain ending in the specified value will be considered a match (e.g., foo.com will match a.foo.com and b.foo.com in addition to foo.com). Defaults to true for exact match."
},
{
"key": "domain",
"description": "Limits data to the specified request domain. Defaults to all request domains."
},
{
"key": "end",
"description": "Specifies the exclusive end time of the logs to be queried. Must be in valid RFC 3339 format."
},
{
"key": "limit",
"description": "Maximum number of rows to return. Defaults to 10, limited to 100."
},
{
"key": "pops",
"description": "Comma-separated list of Fastly POP codes. Omission defaults to all POPs."
},
{
"key": "service_id",
"description": "Specifies the ID of the service for which data should be returned."
},
{
"key": "start",
"description": "Specifies the inclusive start time of the logs to be queried. Must be in valid RFC 3339 format."
},
{
"key": "visualization",
"description": "Specifies the Log Insights visualization for which data should be returned."
}
]
},
"description": "Retrieves statistics from sampled log records.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 Retrieves log insights for the specified service and visualization.",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"oneOf\":[{\"data\":[[{\"dimensions\":null,\"url\":\"GET /content/edge_check\",\"values\":{\"cache_hit_ratio\\\"\":0.01}},{\"dimensions\":null,\"url\":\"GET /health\",\"values\":{\"cache_hit_ratio\":0.02}},{\"dimensions\":null,\"url\":\"HEAD /internal/dns/configurations/pdnsdatad\",\"values\":{\"cache_hit_ratio\":0.03}}]],\"meta\":{\"filters\":{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start\":\"2024-01-01T14:30:23.51559064-06:00\",\"end\\\"\":\"2024-01-05T14:30:23.51559064-06:00\",\"domain_exact_match\":true,\"limit\":10}}},{\"data\":[[{\"dimensions\":{\"country\":\"GBR\"},\"dimension_attributes\":{\"country_chr\":1,\"country_error_rate\":0.5,\"country_request_rate\":0.06451612903225806},\"values\":[{\"region\":\"KTT\",\"region_chr\":1,\"region_error_rate\":0.5}]},{\"dimensions\":{\"country\":\"USA\"},\"dimension_attributes\":{\"country_chr\":0.10344827586206896,\"country_error_rate\":0.1724137931034483,\"country_request_rate\":0.9354838709677419},\"values\":[{\"region\":\"NY\",\"region_chr\":1,\"region_error_rate\":0.5},{\"region\":\"OH\",\"region_chr\":0.037037037037037035,\"region_error_rate\":0.14814814814814814}]}]],\"meta\":{\"filters\":{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start\":\"2024-01-01T14:30:23.51559064-06:00\",\"end\\\"\":\"2024-01-05T14:30:23.51559064-06:00\",\"domain_exact_match\":true,\"limit\":10}}},{\"data\":[[{\"dimensions\":{\"status_code\":200},\"dimension_attributes\":{\"rate\":0.7419354838709677},\"values\":[{\"rate_per_status\":0.6521739130434783,\"rate_per_url\":0.9375,\"url\":\"GET /health\"},{\"rate_per_status\":0.2608695652173913,\"rate_per_url\":0.75,\"url\":\"HEAD /internal/dns/configurations/pdnsdatad\"},{\"rate_per_status\":0.043478260869565216,\"rate_per_url\":0.5,\"url\":\"GET /content/edge_check\"}]},{\"dimensions\":{\"status_code\":503},\"dimension_attributes\":{\"rate\":0.0967741935483871},\"values\":[{\"rate_per_status\":0.6666666666666666,\"rate_per_url\":0.25,\"url\":\"HEAD /internal/dns/configurations/pdnsdatad\"},{\"rate_per_status\":0.3333333333333333,\"rate_per_url\":0.25,\"url\":\"/\"}]},{\"dimensions\":{\"status_code\":301},\"dimension_attributes\":{\"rate\":0.06451612903225806},\"values\":[{\"rate_per_status\":1,\"rate_per_url\":0.5,\"url\":\"/\"}]},{\"dimensions\":{\"status_code\":401},\"dimension_attributes\":{\"rate\":0.03225806451612903},\"values\":[{\"rate_per_status\":1,\"rate_per_url\":0.25,\"url\":\"/\"}]},{\"dimensions\":{\"status_code\":403},\"dimension_attributes\":{\"rate\":0.03225806451612903},\"values\":[{\"rate_per_status\":1,\"rate_per_url\":0.5,\"url\":\"GET /content/edge_check\"}]},{\"dimensions\":{\"status_code\":500},\"dimension_attributes\":{\"rate\":0.03225806451612903},\"values\":[{\"rate_per_status\":1,\"rate_per_url\":0.0625,\"url\":\"GET /health\"}]}]],\"meta\":{\"filters\":{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start\":\"2024-01-01T14:30:23.51559064-06:00\",\"end\\\"\":\"2024-01-05T14:30:23.51559064-06:00\",\"domain_exact_match\":true,\"limit\":10}}},{\"data\":[[{\"dimensions\":{\"url\":\"GET /content/edge_check\"},\"dimension_attributes\":{\"rate\":0.5}},{\"dimensions\":{\"url\":\"/\"},\"dimension_attributes\":{\"rate\":0.25}}]],\"meta\":{\"filters\":{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start\":\"2024-01-01T14:30:23.51559064-06:00\",\"end\\\"\":\"2024-01-05T14:30:23.51559064-06:00\",\"domain_exact_match\":true,\"limit\":10}}},{\"data\":[[{\"dimensions\":{\"response\":\"first byte timeout\"},\"dimension_attributes\":{\"rate\":0.06451612903225806},\"values\":[{\"503_rate_per_url\":0.25,\"rate_per_url\":0.5,\"url\":\"/\"},{\"503_rate_per_url\":0.125,\"rate_per_url\":0.5,\"url\":\"HEAD /internal/dns/configurations/pdnsdatad\"}]},{\"dimensions\":{\"response\":\"backend read error\"},\"dimension_attributes\":{\"rate\":0.03225806451612903},\"values\":[{\"503_rate_per_url\":0.125,\"rate_per_url\":1,\"url\":\"HEAD /internal/dns/configurations/pdnsdatad\"}]}]],\"meta\":{\"filters\":{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start\":\"2024-01-01T14:30:23.51559064-06:00\",\"end\\\"\":\"2024-01-05T14:30:23.51559064-06:00\",\"domain_exact_match\":true,\"limit\":10}}},{\"data\":[[{\"dimensions\":{\"browser\":\"Chrome\"},\"dimension_attributes\":{\"rate\":0.9},\"values\":[{\"browser_version\":\"118.0\",\"rate\":0.75},{\"browser_version\":\"119.0\",\"rate\":0.25}]},{\"dimensions\":{\"browser\":\"Safari\"},\"dimension_attributes\":{\"rate\":0.1},\"values\":[{\"browser_version\":\"18.0\",\"rate\":0.55},{\"browser_version\":\"19.0\",\"rate\":0.45}]}]],\"meta\":{\"filters\":{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start\":\"2024-01-01T14:30:23.51559064-06:00\",\"end\\\"\":\"2024-01-05T14:30:23.51559064-06:00\",\"domain_exact_match\":true,\"limit\":10}}},{\"data\":[[{\"dimensions\":{\"content_type\":\"text/html\"},\"values\":[{\"rate\":0.5161290322580645}]},{\"dimensions\":{\"content_type\":\"application/vnd.api+json\"},\"values\":[{\"rate\":0.25806451612903225}]},{\"dimensions\":{\"content_type\":\"\\n
\"}"
}
]
},
{
"name": "Download a custom VCL file",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "text/plain"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/vcl/{{vcl_name}}/download",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"vcl",
"{{vcl_name}}",
"download"
]
},
"description": "Download the specified VCL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "text/plain"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/vcl/test-vcl/download",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"vcl",
"test-vcl",
"download"
]
},
"description": "Download the specified VCL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "*VCL*"
}
]
},
{
"name": "Get the generated VCL for a service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/generated_vcl",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"generated_vcl"
]
},
"description": "Display the generated VCL for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/generated_vcl",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"generated_vcl"
]
},
"description": "Display the generated VCL for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"content\":\"backend default {\\n .host = \\\"127.0.0.1\\\";\\n .port = \\\"9092\\\";\\n}\\n\\nsub vcl_recv {\\n set req.backend = default;\\n}\\n\\nsub vcl_hash {\\n set req.hash += req.url;\\n set req.hash += req.http.host;\\n set req.hash += \\\"0\\\";\\n}\\n\",\"main\":false,\"name\":\"test-vcl\"}"
}
]
},
{
"name": "Get the generated VCL with syntax highlighting",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/generated_vcl/content",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"generated_vcl",
"content"
]
},
"description": "Display the content of generated VCL with HTML syntax highlighting. Include line numbers by sending lineno=true as a request parameter.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/generated_vcl/content",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"generated_vcl",
"content"
]
},
"description": "Display the content of generated VCL with HTML syntax highlighting. Include line numbers by sending lineno=true as a request parameter.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"content\":\"backend default {\\n .host = "127.0.0.1";\\n .port = "80";\\n}\\nsub vcl_recv {\\n set req.backend = default;\\n}\\nsub vcl_hash {\\n set req.hash += req.url;\\n set req.hash += req.http.host;\\n set req.hash += "0";\\n}\\n\\n
\\n
\"}"
}
]
},
{
"name": "Set a custom VCL file as main",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/vcl/{{vcl_name}}/main",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"vcl",
"{{vcl_name}}",
"main"
]
},
"description": "Set the specified VCL as the main.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/vcl/test-vcl/main",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"vcl",
"test-vcl",
"main"
]
},
"description": "Set the specified VCL as the main.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"content\":\"backend default {\\n .host = \\\"127.0.0.1\\\";\\n .port = \\\"9092\\\";\\n}\\n\\nsub vcl_recv {\\n set req.backend = default;\\n}\\n\\nsub vcl_hash {\\n set req.hash += req.url;\\n set req.hash += req.http.host;\\n set req.hash += \\\"0\\\";\\n}\\n\",\"main\":true,\"name\":\"test-vcl\"}"
}
]
},
{
"name": "Lint (validate) VCL using flags set for the service",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/lint",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"lint"
]
},
"description": "Services may have flags set by a Fastly employee or by the purchase of products as addons to the service, which modify the way VCL is interpreted by that service. This endpoint validates the submitted VCL in the context of the specified service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": []
},
{
"name": "Lint (validate) VCL using a default set of flags",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"url": {
"raw": "{{fastly_url}}/vcl_lint",
"host": [
"{{fastly_url}}"
],
"path": [
"vcl_lint"
]
},
"description": "This endpoint validates the submitted VCL against a default set of enabled flags. Consider using the /service/{service_id}/lint operation to validate VCL in the context of a specific service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": []
}
],
"description": "A VCL is a Varnish configuration file used to customize the configuration for a Service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| content | string | The VCL code to be included. |\n| main | boolean | Set to true when this is the main VCL, otherwise false. |\n| name | string | The name of this VCL. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Load balancing",
"item": [
{
"name": "Directors",
"item": [
{
"name": "Director backend",
"item": [
{
"name": "Get a director-backend relationship",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director/{{director_name}}/backend/{{backend_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director",
"{{director_name}}",
"backend",
"{{backend_name}}"
]
},
"description": "Returns the relationship between a Backend and a Director. If the Backend has been associated with the Director, it returns a simple record indicating this. Otherwise, returns a 404.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director/test-director/backend/test-backend",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director",
"test-director",
"backend",
"test-backend"
]
},
"description": "Returns the relationship between a Backend and a Director. If the Backend has been associated with the Director, it returns a simple record indicating this. Otherwise, returns a 404.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"backend_name\":\"test-backend\",\"created_at\":\"2020-05-05T20:26:56.000Z\",\"deleted_at\":null,\"director_name\":\"test-director\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-05T20:26:56.000Z\",\"version\":1}"
}
]
},
{
"name": "Create a director-backend relationship",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director/{{director_name}}/backend/{{backend_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director",
"{{director_name}}",
"backend",
"{{backend_name}}"
]
},
"description": "Establishes a relationship between a Backend and a Director. The Backend is then considered a member of the Director and can be used to balance traffic onto.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director/test-director/backend/test-backend",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director",
"test-director",
"backend",
"test-backend"
]
},
"description": "Establishes a relationship between a Backend and a Director. The Backend is then considered a member of the Director and can be used to balance traffic onto.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"backend_name\":\"test-backend\",\"created_at\":\"2020-05-05T20:26:56.000Z\",\"deleted_at\":null,\"director_name\":\"test-director\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-05T20:26:56.000Z\",\"version\":1}"
}
]
},
{
"name": "Delete a director-backend relationship",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director/{{director_name}}/backend/{{backend_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director",
"{{director_name}}",
"backend",
"{{backend_name}}"
]
},
"description": "Deletes the relationship between a Backend and a Director. The Backend is no longer considered a member of the Director and thus will not have traffic balanced onto it from this Director.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director/test-director/backend/test-backend",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director",
"test-director",
"backend",
"test-backend"
]
},
"description": "Deletes the relationship between a Backend and a Director. The Backend is no longer considered a member of the Director and thus will not have traffic balanced onto it from this Director.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "Maps and relates backends as belonging to directors. Backends can belong to any number of directors but directors can only hold one reference to a specific backend.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| backend_name | string | The name of the backend. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| director | string | Name for the Director. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Director",
"item": [
{
"name": "List directors",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director"
]
},
"description": "List the directors for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director"
]
},
"description": "List the directors for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"backends\":[],\"capacity\":100,\"comment\":\"\",\"name\":\"test-director\",\"quorum\":75,\"retries\":10,\"shield\":null,\"type\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-05-04T21:19:41.000Z\",\"updated_at\":\"2020-05-04T21:29:15.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Create a director",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director"
]
},
"description": "Create a director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director"
]
},
"description": "Create a director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"backends\":[],\"capacity\":100,\"comment\":\"\",\"name\":\"test-director\",\"quorum\":75,\"retries\":10,\"shield\":null,\"type\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-05-04T21:19:41.000Z\",\"updated_at\":\"2020-05-04T21:29:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Get a director",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director/{{director_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director",
"{{director_name}}"
]
},
"description": "Get the director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director/test-director",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director",
"test-director"
]
},
"description": "Get the director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"backends\":[],\"capacity\":100,\"comment\":\"\",\"name\":\"test-director\",\"quorum\":75,\"retries\":10,\"shield\":null,\"type\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-05-04T21:19:41.000Z\",\"updated_at\":\"2020-05-04T21:29:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Update a director",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director/{{director_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director",
"{{director_name}}"
]
},
"description": "Update the director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director/test-director",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director",
"test-director"
]
},
"description": "Update the director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"backends\":[],\"capacity\":100,\"comment\":\"\",\"name\":\"updated-test-director\",\"quorum\":75,\"retries\":20,\"shield\":null,\"type\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-05-04T21:19:41.000Z\",\"updated_at\":\"2020-05-04T21:29:15.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete a director",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/director/{{director_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"director",
"{{director_name}}"
]
},
"description": "Delete the director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/director/test-director",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"director",
"test-director"
]
},
"description": "Delete the director for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "A Director is responsible for balancing requests among a group of Backends. In addition to simply balancing, Directors can be configured to attempt retrying failed requests. Additionally, Directors have a quorum setting which can be used to determine when the Director as a whole is considered \"up\", in order to prevent \"server whack-a-mole\" following an outage as servers come back up. Only directors created via the API can be modified via the API. Directors known as \"autodirectors\" that are created automatically when load balancing groups of servers together cannot be modified or retrieved via the API.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| backends | array | List of backends associated to a director. |\n| capacity | integer | Unused. |\n| comment | string | A freeform descriptive note. |\n| name | string | Name for the Director. |\n| quorum | integer | The percentage of capacity that needs to be up for a director to be considered up. 0 to 100. |\n| retries | integer | How many backends to search if it fails. |\n| shield | string | Selected POP to serve as a shield for the backends. Defaults to null meaning no origin shielding if not set. Refer to the POPs API endpoint to get a list of available POPs used for shielding. |\n| type | integer | What type of load balance group to use. |\n| | 1 | Random. |\n| | 3 | Hash. |\n| | 4 | Client. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
},
{
"name": "Dynamic server pools",
"item": [
{
"name": "Pool",
"item": [
{
"name": "List server pools",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/pool",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"pool"
]
},
"description": "Lists all pools for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/pool",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"pool"
]
},
"description": "Lists all pools for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"between_bytes_timeout\":\"10000\",\"id\":\"2Yd1WfiCBPENLloXfXmlO\",\"service_id\":\"62SNBYLi10xp1iixmsAcXy\",\"version\":\"1\",\"name\":\"test-pool\",\"shield\":null,\"override_host\":null,\"use_tls\":\"0\",\"type\":\"random\",\"request_condition\":null,\"max_conn_default\":\"200\",\"connect_timeout\":\"1000\",\"first_byte_timeout\":\"15000\",\"quorum\":\"75\",\"tls_ca_cert\":null,\"tls_ciphers\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"tls_sni_hostname\":null,\"tls_check_cert\":\"1\",\"tls_cert_hostname\":null,\"min_tls_version\":null,\"max_tls_version\":null,\"healthcheck\":null,\"comment\":\"\",\"created_at\":\"2020-06-20T03:55:06.000Z\",\"updated_at\":\"2020-06-20T03:55:06.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Create a server pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/pool",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"pool"
]
},
"description": "Creates a pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/pool",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"pool"
]
},
"description": "Creates a pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"between_bytes_timeout\":\"10000\",\"id\":\"2Yd1WfiCBPENLloXfXmlO\",\"service_id\":\"62SNBYLi10xp1iixmsAcXy\",\"version\":\"1\",\"name\":\"test-pool\",\"shield\":null,\"override_host\":null,\"use_tls\":\"0\",\"type\":\"random\",\"request_condition\":null,\"max_conn_default\":\"200\",\"connect_timeout\":\"1000\",\"first_byte_timeout\":\"15000\",\"quorum\":75,\"tls_ca_cert\":null,\"tls_ciphers\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"tls_sni_hostname\":null,\"tls_check_cert\":\"1\",\"tls_cert_hostname\":null,\"min_tls_version\":null,\"max_tls_version\":null,\"healthcheck\":null,\"comment\":\"\",\"created_at\":\"2020-06-20T03:55:06.000Z\",\"updated_at\":\"2020-06-20T03:55:06.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Get a server pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/pool/{{pool_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"pool",
"{{pool_name}}"
]
},
"description": "Gets a single pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/pool/my-pool",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"pool",
"my-pool"
]
},
"description": "Gets a single pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"between_bytes_timeout\":\"10000\",\"id\":\"2Yd1WfiCBPENLloXfXmlO\",\"service_id\":\"62SNBYLi10xp1iixmsAcXy\",\"version\":\"1\",\"name\":\"test-pool\",\"shield\":null,\"override_host\":null,\"use_tls\":\"0\",\"type\":\"random\",\"request_condition\":null,\"max_conn_default\":\"200\",\"connect_timeout\":\"1000\",\"first_byte_timeout\":\"15000\",\"quorum\":\"75\",\"tls_ca_cert\":null,\"tls_ciphers\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"tls_sni_hostname\":null,\"tls_check_cert\":\"1\",\"tls_cert_hostname\":null,\"min_tls_version\":null,\"max_tls_version\":null,\"healthcheck\":null,\"comment\":\"\",\"created_at\":\"2020-06-20T03:55:06.000Z\",\"updated_at\":\"2020-06-20T03:55:06.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Update a server pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/pool/{{pool_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"pool",
"{{pool_name}}"
]
},
"description": "Updates a specific pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/pool/my-pool",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"pool",
"my-pool"
]
},
"description": "Updates a specific pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"between_bytes_timeout\":\"10000\",\"id\":\"2Yd1WfiCBPENLloXfXmlO\",\"service_id\":\"62SNBYLi10xp1iixmsAcXy\",\"version\":\"1\",\"name\":\"test-pool\",\"shield\":null,\"override_host\":null,\"use_tls\":\"0\",\"type\":\"random\",\"request_condition\":null,\"max_conn_default\":\"300\",\"connect_timeout\":\"1000\",\"first_byte_timeout\":\"15000\",\"quorum\":\"75\",\"tls_ca_cert\":null,\"tls_ciphers\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"tls_sni_hostname\":null,\"tls_check_cert\":\"1\",\"tls_cert_hostname\":null,\"min_tls_version\":null,\"max_tls_version\":null,\"healthcheck\":null,\"comment\":\"\",\"created_at\":\"2020-06-20T03:55:06.000Z\",\"updated_at\":\"2020-06-20T03:55:06.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete a server pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/pool/{{pool_name}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"version",
"{{version_id}}",
"pool",
"{{pool_name}}"
]
},
"description": "Deletes a specific pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/pool/my-pool",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"version",
"1",
"pool",
"my-pool"
]
},
"description": "Deletes a specific pool for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
}
],
"description": "A pool is responsible for balancing requests among a group of servers. In addition to balancing, pools can be configured to attempt retrying failed requests. Pools have a quorum setting that can be used to determine when the pool as a whole is considered up, in order to prevent problems following an outage as servers come back up.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| comment | string | A freeform descriptive note. |\n| healthcheck | string | Name of the healthcheck to use with this pool. Can be empty and could be reused across multiple backend and pools. |\n| max_tls_version | integer | Maximum allowed TLS version on connections to this server. Optional. |\n| min_tls_version | integer | Minimum allowed TLS version on connections to this server. Optional. |\n| name | string | Name for the Pool. |\n| override_host | string | The hostname to override the Host header. Defaults to null meaning no override of the Host header will occur. This setting can also be added to a Server definition. If the field is set on a Server definition it will override the Pool setting. |\n| request_condition | string | Condition which, if met, will select this configuration during a request. Optional. |\n| shield | string | Selected POP to serve as a shield for the servers. Defaults to null meaning no origin shielding if not set. Refer to the POPs API endpoint to get a list of available POPs used for shielding. |\n| tls_ciphers | string | List of OpenSSL ciphers (see the openssl.org manpages for details). Optional. |\n| tls_sni_hostname | string | SNI hostname. Optional. |\n| type | string | What type of load balance group to use. |\n| between_bytes_timeout | integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using bereq.between_bytes_timeout. |\n| connect_timeout | integer | How long to wait for a timeout in milliseconds. Optional. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| first_byte_timeout | integer | How long to wait for the first byte in milliseconds. Optional. |\n| max_conn_default | integer | Maximum number of connections. Optional. |\n| quorum | integer | Percentage of capacity (0-100) that needs to be operationally available for a pool to be considered up. |\n| service_id | string | Alphanumeric string identifying the service. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_cert_hostname | string | The hostname used to verify a server's certificate. It can either be the Common Name (CN) or a Subject Alternative Name (SAN). |\n| tls_check_cert | integer | Be strict on checking TLS certs. Optional. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| use_tls | integer | Whether to use TLS. |\n| | 0 | Do not use TLS. |\n| | 1 | Use TLS. |\n| version | string | String identifying a service version. |\n| id | string | Alphanumeric string identifying a Pool. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
},
{
"name": "Server",
"item": [
{
"name": "List servers in a pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/pool/{{pool_id}}/servers",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"pool",
"{{pool_id}}",
"servers"
]
},
"description": "Lists all servers for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/pool/2Yd1WfiCBPENLloXfXmlO/servers",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"pool",
"2Yd1WfiCBPENLloXfXmlO",
"servers"
]
},
"description": "Lists all servers for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "[{\"id\":\"6kEuoknxiaDBCLiAjKqyXq\",\"service_id\":\"6k2He0IyVFUTO6RNO1BNDe\",\"pool_id\":\"6kAX81nQ1jsNWZGnXvFSKY\",\"weight\":100,\"max_conn\":200,\"port\":80,\"override_host\":null,\"address\":\"example.com\",\"comment\":\"\",\"disabled\":false,\"created_at\":\"2020-06-20T08:20:36.000Z\",\"updated_at\":\"2020-06-20T08:20:36.000Z\",\"deleted_at\":null}]"
}
]
},
{
"name": "Get a pool server",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/pool/{{pool_id}}/server/{{server_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"pool",
"{{pool_id}}",
"server",
"{{server_id}}"
]
},
"description": "Gets a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/pool/2Yd1WfiCBPENLloXfXmlO/server/6kEuoknxiaDBCLiAjKqyXq",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"pool",
"2Yd1WfiCBPENLloXfXmlO",
"server",
"6kEuoknxiaDBCLiAjKqyXq"
]
},
"description": "Gets a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6kEuoknxiaDBCLiAjKqyXq\",\"service_id\":\"6k2He0IyVFUTO6RNO1BNDe\",\"pool_id\":\"6kAX81nQ1jsNWZGnXvFSKY\",\"weight\":100,\"max_conn\":200,\"port\":80,\"override_host\":null,\"address\":\"example.com\",\"comment\":\"\",\"disabled\":false,\"created_at\":\"2020-06-20T08:20:36.000Z\",\"updated_at\":\"2020-06-20T08:20:36.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Update a server",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/pool/{{pool_id}}/server/{{server_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"pool",
"{{pool_id}}",
"server",
"{{server_id}}"
]
},
"description": "Updates a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "PUT",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/pool/2Yd1WfiCBPENLloXfXmlO/server/6kEuoknxiaDBCLiAjKqyXq",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"pool",
"2Yd1WfiCBPENLloXfXmlO",
"server",
"6kEuoknxiaDBCLiAjKqyXq"
]
},
"description": "Updates a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6kEuoknxiaDBCLiAjKqyXq\",\"service_id\":\"6k2He0IyVFUTO6RNO1BNDe\",\"pool_id\":\"6kAX81nQ1jsNWZGnXvFSKY\",\"weight\":100,\"max_conn\":300,\"port\":80,\"override_host\":null,\"address\":\"example.com\",\"comment\":\"\",\"disabled\":false,\"created_at\":\"2020-06-20T08:20:36.000Z\",\"updated_at\":\"2020-06-20T08:20:36.000Z\",\"deleted_at\":null}"
}
]
},
{
"name": "Delete a server from a pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/pool/{{pool_id}}/server/{{server_id}}",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"pool",
"{{pool_id}}",
"server",
"{{server_id}}"
]
},
"description": "Deletes a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/pool/2Yd1WfiCBPENLloXfXmlO/server/6kEuoknxiaDBCLiAjKqyXq",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"pool",
"2Yd1WfiCBPENLloXfXmlO",
"server",
"6kEuoknxiaDBCLiAjKqyXq"
]
},
"description": "Deletes a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"status\":\"ok\"}"
}
]
},
{
"name": "Add a server to a pool",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "{{fastly_url}}/service/{{service_id}}/pool/{{pool_id}}/server",
"host": [
"{{fastly_url}}"
],
"path": [
"service",
"{{service_id}}",
"pool",
"{{pool_id}}",
"server"
]
},
"description": "Creates a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
},
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "in",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Host",
"value": "api.fastly.com"
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": []
},
"url": {
"raw": "https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/pool/2Yd1WfiCBPENLloXfXmlO/server",
"protocol": "https",
"host": [
"api",
"fastly",
"com"
],
"path": [
"service",
"SU1Z0isxPaozGVKXdv0eY",
"pool",
"2Yd1WfiCBPENLloXfXmlO",
"server"
]
},
"description": "Creates a single server for a particular service and pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n"
},
"status": "200 OK",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": "{\"id\":\"6kEuoknxiaDBCLiAjKqyXq\",\"service_id\":\"6k2He0IyVFUTO6RNO1BNDe\",\"pool_id\":\"6kAX81nQ1jsNWZGnXvFSKY\",\"weight\":100,\"max_conn\":200,\"port\":80,\"override_host\":null,\"address\":\"new-example.com\",\"comment\":\"\",\"disabled\":false,\"created_at\":\"2020-06-20T08:20:36.000Z\",\"updated_at\":\"2020-06-20T08:20:36.000Z\",\"deleted_at\":null}"
}
]
}
],
"description": "A server is an address (IP address or hostname) to which the Fastly Load Balancer service can forward requests. This service can define multiple servers and assign it to a pool. Fastly can then select any one of these servers based on a selection policy defined for the pool.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | A hostname, IPv4, or IPv6 address for the server. Required. |\n| comment | string | A freeform descriptive note. |\n| disabled | boolean | Allows servers to be enabled and disabled in a pool. |\n| max_conn | integer | Maximum number of connections. If the value is 0, it inherits the value from pool's max_conn_default. |\n| override_host | string | The hostname to override the Host header. Defaults to null meaning no override of the Host header if not set. This setting can also be added to a Pool definition. However, the server setting will override the Pool setting. |\n| port | integer | Port number. Setting port 443 does not force TLS. Set use_tls in pool to force TLS. |\n| weight | integer | Weight (1-100) used to load balance this server against others. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a Server. |\n| pool_id | string | Alphanumeric string identifying a Pool. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |",
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{fastly_key}}",
"type": "string"
},
{
"key": "key",
"value": "Fastly-Key",
"type": "string"
}
]
}
}
]
}
]
}
],
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
],
"variable": [
{
"key": "fastly_url",
"value": "https://api.fastly.com"
},
{
"key": "customer_id"
},
{
"key": "contact_id"
},
{
"key": "event_id"
},
{
"key": "invitation_id"
},
{
"key": "invoice_id"
},
{
"key": "service_authorization_id"
},
{
"key": "star_id"
},
{
"key": "user_id"
},
{
"key": "user_login"
},
{
"key": "acl_id"
},
{
"key": "service_id"
},
{
"key": "acl_entry_id"
},
{
"key": "version_id"
},
{
"key": "acl_name"
},
{
"key": "acl_ip"
},
{
"key": "id"
},
{
"key": "token_id"
},
{
"key": "dictionary_id"
},
{
"key": "dictionary_item_key"
},
{
"key": "dictionary_name"
},
{
"key": "dns_configuration_id"
},
{
"key": "tls_configuration_id"
},
{
"key": "backend_name"
},
{
"key": "director_name"
},
{
"key": "pool_name"
},
{
"key": "pool_id"
},
{
"key": "server_id"
},
{
"key": "logging_azureblob_name"
},
{
"key": "logging_bigquery_name"
},
{
"key": "logging_cloudfiles_name"
},
{
"key": "logging_datadog_name"
},
{
"key": "logging_digitalocean_name"
},
{
"key": "logging_elasticsearch_name"
},
{
"key": "logging_ftp_name"
},
{
"key": "logging_gcs_name"
},
{
"key": "logging_google_pubsub_name"
},
{
"key": "logging_grafanacloudlogs_name"
},
{
"key": "logging_heroku_name"
},
{
"key": "logging_honeycomb_name"
},
{
"key": "logging_https_name"
},
{
"key": "logging_kafka_name"
},
{
"key": "logging_kinesis_name"
},
{
"key": "logging_loggly_name"
},
{
"key": "logging_logshuttle_name"
},
{
"key": "logging_newrelic_name"
},
{
"key": "logging_newrelicotlp_name"
},
{
"key": "logging_openstack_name"
},
{
"key": "logging_papertrail_name"
},
{
"key": "logging_s3_name"
},
{
"key": "logging_scalyr_name"
},
{
"key": "logging_sftp_name"
},
{
"key": "logging_splunk_name"
},
{
"key": "logging_sumologic_name"
},
{
"key": "logging_syslog_name"
},
{
"key": "start_timestamp"
},
{
"key": "max_entries"
},
{
"key": "field"
},
{
"key": "timestamp_in_seconds"
},
{
"key": "definition_id"
},
{
"key": "dashboard_id"
},
{
"key": "integration_id"
},
{
"key": "workspace_id"
},
{
"key": "request_id"
},
{
"key": "redaction_id"
},
{
"key": "rule_id"
},
{
"key": "virtual_patch_id"
},
{
"key": "domain_name"
},
{
"key": "healthcheck_name"
},
{
"key": "config_store_id"
},
{
"key": "config_store_item_key"
},
{
"key": "store_id"
},
{
"key": "key"
},
{
"key": "access_key"
},
{
"key": "secret_name"
},
{
"key": "environment_name"
},
{
"key": "tls_activation_id"
},
{
"key": "tls_certificate_id"
},
{
"key": "tls_private_key_id"
},
{
"key": "mutual_authentication_id"
},
{
"key": "certificate_id"
},
{
"key": "tls_subscription_id"
},
{
"key": "tls_authorization_id"
},
{
"key": "globalsign_email_challenge_id"
},
{
"key": "from_version_id"
},
{
"key": "to_version_id"
},
{
"key": "subject"
},
{
"key": "section"
},
{
"key": "domain_id"
},
{
"key": "cached_url"
},
{
"key": "surrogate_key"
},
{
"key": "apex_redirect_id"
},
{
"key": "cache_settings_name"
},
{
"key": "condition_name"
},
{
"key": "gzip_name"
},
{
"key": "header_name"
},
{
"key": "rate_limiter_id"
},
{
"key": "request_settings_name"
},
{
"key": "response_object_name"
},
{
"key": "name"
},
{
"key": "vcl_name"
}
]
}
================================================
FILE: tests/sample-importable-collections/test-postman-collection.json
================================================
{
"info": {
"name": "Test API",
"description": "A test API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": [{"key": "baseUrl", "value": "https://api.example.com"}],
"item": [
{
"name": "Users",
"item": [
{
"name": "Get Users",
"request": {
"method": "GET",
"url": {
"raw": "{{host}}/api/users?email=example@gmail.com&relations=organization,impersonating_user",
"host": ["{{host}}"],
"path": ["api", "users"],
"query": [
{"key": "email", "value": "example@gmail.com"},
{
"key": "relations",
"value": "organization,impersonating_user"
}
]
}
}
},
{
"name": "User Details",
"item": [
{
"name": "Get User",
"request": {
"method": "GET",
"url": {
"raw": "{{baseUrl}}/users/{id}",
"host": ["{{baseUrl}}"],
"path": ["users", "{id}"]
}
}
}
]
}
]
}
]
}
================================================
FILE: tests/sample-themes/another_test.yml
================================================
name: anothertest
primary: '#2ecc71'
secondary: '#3498db'
accent: '#9b59b6'
background: '#ecf0f1'
surface: '#bdc3c7'
error: '#e74c3c'
warning: '#f39c12'
success: '#27ae60'
panel: '#95a5a6'
# Extended properties
text_area:
gutter: 'black on red'
cursor: 'reverse'
cursor_line: 'italic'
cursor_line_gutter: 'black on blue'
matched_bracket: 'underline #f1c40f'
selection: 'on #3498db'
syntax:
json_key: '#8e44ad'
json_string: '#27ae60'
json_number: '#e67e22'
json_boolean: '#e74c3c'
json_null: '#95a5a6'
url:
base: 'italic #3498db on green'
protocol: 'u bold #9b59b6 on magenta'
separator: 'dim red u'
variable:
resolved: 'black on #00ff00'
unresolved: 'black on #ff0000'
# Optional metadata
author: "Your Name"
description: "A vibrant and colorful theme with extended properties"
homepage: "https://github.com/yourusername/posting-themes"
================================================
FILE: tests/sample-themes/serene_ocean.yaml
================================================
name: serene_ocean
primary: '#1E88E5' # Ocean Blue
secondary: '#00ACC1' # Teal
accent: '#D32F2F' # Crimson Red
background: '#E3F2FD' # Light Sky Blue
surface: '#FFFFFF' # White
error: '#D32F2F' # Crimson Red
success: '#43A047' # Forest Green
text: '#212121' # Almost Black
dark: false
================================================
FILE: tests/test_curl_export.py
================================================
import pytest
from posting.collection import (
RequestModel,
Header,
QueryParam,
Auth,
FormItem,
Cookie,
Options,
RequestBody,
)
@pytest.fixture
def basic_request():
"""Fixture providing a basic request model for testing."""
return RequestModel(
name="Test Request", method="GET", url="https://example.com/api"
)
def test_simple_get_request():
"""Test a simple GET request with no parameters."""
request = RequestModel(
name="Simple GET", method="GET", url="https://example.com/api"
)
expected = "curl \\\n 'https://example.com/api'"
assert request.to_curl() == expected
def test_post_request_with_body():
"""Test a POST request with a JSON body."""
request = RequestModel(
name="POST with body",
method="POST",
url="https://example.com/api/users",
body=RequestBody(content='{"name": "John Doe", "email": "john@example.com"}'),
)
expected = 'curl \\\n -X POST \\\n -d \'{"name": "John Doe", "email": "john@example.com"}\' \\\n \'https://example.com/api/users\''
assert request.to_curl() == expected
def test_request_with_headers():
"""Test a request with custom headers."""
request = RequestModel(
name="Request with headers",
method="GET",
url="https://example.com/api",
headers=[
Header(name="Content-Type", value="application/json"),
Header(name="Authorization", value="Bearer token123"),
Header(name="Disabled-Header", value="value", enabled=False),
],
)
expected = "curl \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: Bearer token123' \\\n 'https://example.com/api'"
assert request.to_curl() == expected
def test_request_with_query_params():
"""Test a request with query parameters."""
request = RequestModel(
name="Request with query params",
method="GET",
url="https://example.com/api/search",
params=[
QueryParam(name="q", value="test query"),
QueryParam(name="page", value="1"),
QueryParam(name="disabled", value="true", enabled=False),
],
)
expected = "curl \\\n 'https://example.com/api/search?q=test+query&page=1'"
assert request.to_curl() == expected
def test_request_with_existing_query_params():
"""Test a request with existing query parameters in the URL."""
request = RequestModel(
name="Request with existing query params",
method="GET",
url="https://example.com/api/search?existing=value",
params=[
QueryParam(name="q", value="test query"),
QueryParam(name="page", value="1"),
],
)
expected = (
"curl \\\n 'https://example.com/api/search?existing=value&q=test+query&page=1'"
)
assert request.to_curl() == expected
def test_request_with_url_fragment():
"""Test a request with a URL fragment."""
request = RequestModel(
name="Request with URL fragment",
method="GET",
url="https://example.com/api/docs#section1",
params=[QueryParam(name="version", value="1.0")],
)
expected = "curl \\\n 'https://example.com/api/docs?version=1.0#section1'"
assert request.to_curl() == expected
def test_request_with_basic_auth():
"""Test a request with basic authentication."""
request = RequestModel(
name="Request with basic auth",
method="GET",
url="https://example.com/api/secure",
auth=Auth.basic_auth("username", "password"),
)
expected = (
"curl \\\n -u 'username:password' \\\n 'https://example.com/api/secure'"
)
assert request.to_curl() == expected
def test_request_with_digest_auth():
"""Test a request with digest authentication."""
request = RequestModel(
name="Request with digest auth",
method="GET",
url="https://example.com/api/secure",
auth=Auth.digest_auth("username", "password"),
)
expected = "curl \\\n --digest -u 'username:password' \\\n 'https://example.com/api/secure'"
assert request.to_curl() == expected
def test_request_with_cookies():
"""Test a request with cookies."""
request = RequestModel(
name="Request with cookies",
method="GET",
url="https://example.com/api",
cookies=[
Cookie(name="session", value="abc123"),
Cookie(name="preference", value="dark-mode"),
Cookie(name="disabled", value="value", enabled=False),
],
)
expected = "curl \\\n --cookie 'session=abc123' \\\n --cookie 'preference=dark-mode' \\\n 'https://example.com/api'"
assert request.to_curl() == expected
def test_request_with_form_data():
"""Test a request with form data."""
request = RequestModel(
name="Request with form data",
method="POST",
url="https://example.com/api/form",
body=RequestBody(
form_data=[
FormItem(name="name", value="John Doe"),
FormItem(name="email", value="john@example.com"),
FormItem(name="disabled", value="value", enabled=False),
]
),
)
expected = "curl \\\n -X POST \\\n -d 'name=John Doe' \\\n -d 'email=john@example.com' \\\n 'https://example.com/api/form'"
assert request.to_curl() == expected
def test_request_with_options():
"""Test a request with custom options."""
request = RequestModel(
name="Request with options",
method="GET",
url="https://example.com/api",
options=Options(
follow_redirects=False,
verify_ssl=False,
timeout=10.0,
proxy_url="http://proxy.example.com:8080",
),
)
expected = "curl \\\n --no-location \\\n --insecure \\\n --max-time 10.0 \\\n --proxy 'http://proxy.example.com:8080' \\\n 'https://example.com/api'"
assert request.to_curl() == expected
def test_complex_request():
"""Test a complex request with multiple components."""
request = RequestModel(
name="Complex request",
method="POST",
url="https://example.com/api/users?existing=value#section",
headers=[
Header(name="Content-Type", value="application/json"),
Header(name="Authorization", value="Bearer token123"),
],
params=[
QueryParam(name="q", value="test query"),
QueryParam(name="page", value="1"),
],
body=RequestBody(content='{"name": "John Doe", "email": "john@example.com"}'),
auth=Auth.basic_auth("username", "password"),
cookies=[Cookie(name="session", value="abc123")],
options=Options(verify_ssl=False),
)
expected = "curl \\\n -X POST \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: Bearer token123' \\\n -d '{\"name\": \"John Doe\", \"email\": \"john@example.com\"}' \\\n -u 'username:password' \\\n --cookie 'session=abc123' \\\n --insecure \\\n 'https://example.com/api/users?existing=value&q=test+query&page=1#section'"
assert request.to_curl() == expected
def test_special_characters_in_url_and_params():
"""Test handling of special characters in URL and parameters."""
request = RequestModel(
name="Special characters",
method="GET",
url="https://example.com/api/search",
params=[
QueryParam(name="q", value="special chars: !@#$%^&*()"),
QueryParam(name="filter", value="name=John Doe"),
],
)
expected = "curl \\\n 'https://example.com/api/search?q=special+chars%3A+%21%40%23%24%25%5E%26%2A%28%29&filter=name%3DJohn+Doe'"
assert request.to_curl() == expected
================================================
FILE: tests/test_curl_import.py
================================================
from posting.importing.curl import CurlImport
def test_simple_get():
"""Test a simple GET request."""
curl_command = "curl http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.method == "GET"
assert curl_import.url == "http://example.com"
assert curl_import.headers == []
assert curl_import.data is None
def test_get_with_headers():
"""Test GET request with headers."""
curl_command = "curl -H 'Accept: application/json' -H 'User-Agent: TestAgent' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.method == "GET"
assert curl_import.url == "http://example.com"
assert curl_import.headers == [
("Accept", "application/json"),
("User-Agent", "TestAgent"),
]
assert curl_import.data is None
def test_post_with_form_data():
"""Test POST request with form data using -d."""
curl_command = "curl -X POST -d 'key1=value1&key2=value2' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.method == "POST"
assert curl_import.url == "http://example.com"
assert curl_import.data == "key1=value1&key2=value2"
assert curl_import.is_form_data is True
assert curl_import.data_pairs == [("key1", "value1"), ("key2", "value2")]
def test_post_with_json_data():
"""Test POST request with JSON data."""
curl_command = "curl -X POST -H 'Content-Type: application/json' -d '{\"key\":\"value\"}' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.method == "POST"
assert curl_import.url == "http://example.com"
assert curl_import.data == '{"key":"value"}'
assert curl_import.is_form_data is False
assert curl_import.data_pairs == []
def test_post_with_form_option():
"""Test POST request with form data using -d."""
curl_command = (
"curl -X POST -d 'field1=value1' -d 'field2=value2' http://example.com"
)
curl_import = CurlImport(curl_command)
assert curl_import.method == "POST"
assert curl_import.url == "http://example.com"
assert curl_import.data_pairs == [("field1", "value1"), ("field2", "value2")]
assert curl_import.is_form_data is True
def test_multiple_data_options():
"""Test handling of multiple -d options."""
curl_command = "curl -d 'key1=value1' -d 'key2=value2' http://example.com"
curl_import = CurlImport(curl_command)
# Depending on implementation, data might be concatenated or last one used
assert curl_import.data == "key1=value1&key2=value2"
assert curl_import.is_form_data is True
assert curl_import.data_pairs == [("key1", "value1"), ("key2", "value2")]
def test_curl_with_user_and_password():
"""Test parsing of user credentials."""
curl_command = "curl -u username:password http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.user == "username:password"
assert curl_import.url == "http://example.com"
def test_curl_with_bearer_token():
"""Test parsing of user credentials."""
curl_command = "curl http://example.com -H 'Authorization: Bearer my-token'"
curl_import = CurlImport(curl_command)
assert curl_import.headers == [("Authorization", "Bearer my-token")]
assert curl_import.url == "http://example.com"
def test_curl_with_insecure():
"""Test parsing of --insecure flag."""
curl_command = "curl -k http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.insecure is True
def test_curl_with_referer():
"""Test parsing of referer."""
curl_command = "curl -e 'http://referrer.com' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.referer == "http://referrer.com"
def test_curl_with_user_agent():
"""Test parsing of user-agent."""
curl_command = "curl -A 'CustomAgent' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.user_agent == "CustomAgent"
def test_curl_with_compressed():
"""Test parsing of --compressed flag."""
curl_command = "curl --compressed http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.compressed is True
def test_curl_with_method_and_data():
"""Test custom method with data."""
curl_command = "curl -X PUT -d 'key=value' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.method == "PUT"
assert curl_import.data == "key=value"
assert curl_import.is_form_data is True
def test_curl_with_data_raw():
"""Test parsing of --data-raw."""
curl_command = "curl --data-raw 'raw data' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.data == "raw data"
assert curl_import.is_form_data is True
def test_curl_with_data_binary():
"""Test parsing of --data-binary."""
curl_command = "curl --data-binary 'binary data' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.data == "binary data"
assert curl_import.is_form_data is True
def test_curl_with_escaped_newlines():
"""Test parsing of curl command with escaped newlines."""
curl_command = """curl -X POST \\
-H 'Content-Type: application/json' \\
-d '{"key": "value"}' \\
http://example.com"""
curl_import = CurlImport(curl_command)
assert curl_import.method == "POST"
assert curl_import.url == "http://example.com"
assert curl_import.data == '{"key": "value"}'
assert curl_import.headers == [("Content-Type", "application/json")]
def test_curl_with_no_space_in_header():
"""Test headers without space after colon."""
curl_command = "curl -H 'Authorization:Bearer token' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.headers == [("Authorization", "Bearer token")]
def test_curl_with_complex_command():
"""Test a complex curl command."""
curl_command = (
"curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' "
'-d \'{"name":"test","value":123}\' --compressed --insecure '
"http://example.com/api/test"
)
curl_import = CurlImport(curl_command)
assert curl_import.method == "POST"
assert curl_import.url == "http://example.com/api/test"
assert curl_import.headers == [
("Accept", "application/json"),
("Content-Type", "application/json"),
]
assert curl_import.data == '{"name":"test","value":123}'
assert curl_import.compressed is True
assert curl_import.insecure is True
assert curl_import.is_form_data is False
def test_curl_with_utf8_characters():
"""Test curl command with UTF-8 characters."""
curl_command = "curl -d 'param=テスト' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.data == "param=テスト"
assert curl_import.data_pairs == [("param", "テスト")]
def test_curl_with_special_characters_in_data():
"""Test data containing special characters."""
curl_command = "curl -d 'param=hello%20world&key=value%3Dtest' http://example.com"
curl_import = CurlImport(curl_command)
assert curl_import.data == "param=hello%20world&key=value%3Dtest"
assert curl_import.data_pairs == [
("param", "hello%20world"),
("key", "value%3Dtest"),
]
def test_curl_imports_max_time():
"""Test a complex example that includes max-time, which was previously not parsed and
caused imports to be incorrect (fixed in 2.5.1)."""
curl_command = """\
curl \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: *' \
-H 'Cache-Control: no-cache' \
-H 'Accept-Encoding: gzip' \
-d '{
"string": "Hello, world!",
"booleans": [true, false],
"numbers": [1, 2, 42],
"null": null
}' \
-u 'darren:' \
--max-time 0.2 \
'https://postman-echo.com/post?key1=value1&another-key=another-value&number=123'
"""
curl_import = CurlImport(curl_command)
assert curl_import.method == "POST"
assert (
curl_import.url
== "https://postman-echo.com/post?key1=value1&another-key=another-value&number=123"
)
assert curl_import.headers == [
("Content-Type", "application/json"),
("Accept", "*"),
("Cache-Control", "no-cache"),
("Accept-Encoding", "gzip"),
]
assert (
curl_import.data
== """\
{
"string": "Hello, world!",
"booleans": [true, false],
"numbers": [1, 2, 42],
"null": null
}"""
)
assert curl_import.user == "darren:"
================================================
FILE: tests/test_files.py
================================================
import pytest
from posting.files import is_valid_filename
@pytest.mark.parametrize(
"filename, expected",
[
("valid_filename.txt", True),
("", False),
(" ", False),
("file/with/path.txt", False),
("a" * 255, True),
("a" * 256, False),
("CON", False),
("PRN.txt", False),
("AUX.log", False),
("NUL.dat", False),
("COM1.bin", False),
("LPT1.tmp", False),
("file..with..dots.txt", False),
(".hidden_file.txt", False),
("normal.file.txt", True),
("file-with-dashes.txt", True),
("file_with_underscores.txt", True),
("file with spaces.txt", True),
("file.with.multiple.extensions.txt", True),
# Path traversal attack tests
("../filename.txt", False),
("filename/../something.txt", False),
("foo/../bar/baz.txt", False),
("foo/./bar/baz.txt", False),
# Absolute path tests
("/etc/passwd", False),
("/var/log/system.log", False),
("/home/user/file.txt", False),
("/file.txt", False),
("C:/Program Files/file.txt", False),
],
)
def test_is_valid_filename(filename, expected):
assert is_valid_filename(filename) == expected
def test_is_valid_filename_with_none():
assert is_valid_filename(None) is False
@pytest.mark.parametrize(
"os_specific_filename, expected",
[
("COM0", True), # COM0 is not in the reserved list
("LPT0", True), # LPT0 is not in the reserved list
("CON.txt", False),
("AUX.log", False),
],
)
def test_is_valid_filename_os_specific(os_specific_filename, expected):
assert is_valid_filename(os_specific_filename) == expected
================================================
FILE: tests/test_open_api_import.py
================================================
import json
from pathlib import Path
from posting.importing.open_api import import_openapi_spec
def test_import(tmp_path: Path):
"""Test importing security schemes."""
spec = {
"openapi": "3.1.0",
"info": {"title": "Test", "version": "1.0", "description": "Test"},
"paths": {
"/": {
"get": {
"parameters": [
{
"name": "page",
"in": "query",
},
{
"name": "account_id",
"in": "header",
"deprecated": True,
},
],
"responses": {"200": {"description": "OK"}},
"security": [
{"bearerAuth": []},
],
}
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
},
},
},
}
spec_path = tmp_path / "spec.json"
spec_path.write_text(json.dumps(spec))
collection = import_openapi_spec(spec_path)
assert len(collection.requests) == 1
request = collection.requests[0]
assert request.url == "${BASE_URL}/"
assert request.method == "GET"
assert len(request.params) == 1
param = request.params[0]
assert param.name == "page"
assert param.value == ""
assert param.enabled
assert len(request.headers) == 1
header = request.headers[0]
assert header.name == "account_id"
assert header.value == ""
assert not header.enabled
assert request.auth is not None
assert request.auth.type == "bearer_token"
assert request.auth.bearer_token is not None
assert request.auth.bearer_token.token == "${BEARERAUTH_BEARER_TOKEN}"
================================================
FILE: tests/test_postman_import.py
================================================
from pathlib import Path
from posting.collection import Collection, Options, QueryParam, RequestModel, Scripts
from posting.importing.postman import Variable, import_postman_spec
def test_import_postman_spec():
# Write mock Postman spec to a temporary file
collection, postman_collection = import_postman_spec(
spec_path="tests/sample-importable-collections/test-postman-collection.json",
output_path="foo/bar/baz",
)
assert collection == Collection(
path=Path("foo/bar/baz"),
name="Test API",
requests=[],
children=[
Collection(
path=Path("foo/bar/baz/Users"),
name="Users",
requests=[
RequestModel(
name="Get Users",
description="",
method="GET",
url="$HOST/api/users",
path=Path("foo/bar/baz/Users/GetUsers.posting.yaml"),
body=None,
auth=None,
headers=[],
params=[
QueryParam(
name="email", value="example@gmail.com", enabled=True
),
QueryParam(
name="relations",
value="organization,impersonating_user",
enabled=True,
),
],
cookies=[],
posting_version="2.6.0",
scripts=Scripts(setup=None, on_request=None, on_response=None),
options=Options(
follow_redirects=True,
verify_ssl=True,
attach_cookies=True,
proxy_url="",
timeout=5.0,
),
)
],
children=[
Collection(
path=Path("foo/bar/baz/Users/User Details"),
name="User Details",
requests=[
RequestModel(
name="Get User",
description="",
method="GET",
url="$BASE_URL/users/{id}",
path=Path(
"foo/bar/baz/Users/User Details/GetUser.posting.yaml"
),
body=None,
auth=None,
headers=[],
params=[],
cookies=[],
posting_version="2.6.0",
scripts=Scripts(
setup=None, on_request=None, on_response=None
),
options=Options(
follow_redirects=True,
verify_ssl=True,
attach_cookies=True,
proxy_url="",
timeout=5.0,
),
)
],
children=[],
readme=None,
)
],
readme=None,
)
],
readme="# Test API\n\nA test API\n\nVersion: 2.0.0",
)
assert postman_collection.variable == [
Variable(key="baseUrl", value="https://api.example.com")
]
================================================
FILE: tests/test_snapshots.py
================================================
import os
from pathlib import Path
from unittest import mock
import pytest
from textual.pilot import Pilot
from textual.widgets import Input
from posting.__main__ import make_posting
TEST_DIR = Path(__file__).parent
CONFIG_DIR = TEST_DIR / "sample-configs"
ENV_DIR = TEST_DIR / "sample-envs"
THEME_DIR = TEST_DIR / "sample-themes"
SAMPLE_COLLECTIONS = TEST_DIR / "sample-collections"
POSTING_MAIN = TEST_DIR / "posting_snapshot_app.py"
def use_config(file_name: str):
"""Specify which config file to use from the `sample-configs` directory."""
return mock.patch.dict(
os.environ, {"POSTING_CONFIG_FILE": str(CONFIG_DIR / file_name)}
)
def patch_env(key: str, value: str):
"""Decorator to patch and environment variable."""
return mock.patch.dict(os.environ, {key: value})
async def disable_blink_for_active_cursors(pilot: Pilot) -> None:
"""Allows us to disable cursors which could not be disabled via config.
You'll probably want to use this if you open the command palette using a
test, as the config does not target that Input's cursor.
"""
await pilot.pause()
pilot.app.screen.query_one(Input).cursor_blink = False
@use_config("general.yaml")
class TestJumpMode:
@pytest.mark.parametrize("spacing", ["compact", "standard"])
def test_loads(self, spacing, snap_compare):
"""Simple check that ctrl+o enters jump mode."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o")
with patch_env("POSTING_SPACING", spacing):
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_focus_switch(self, snap_compare):
"""Jump mode can target focusable widgets such as the collection tree."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o") # enter jump mode
await pilot.press("tab") # target collection tree
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_click_switch(self, snap_compare):
"""Jump mode can target widgets that are not focusable, such as tabs."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o") # enter jump mode
await pilot.press("u") # target "Options" tab
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
class TestMethodSelection:
def test_select_post_method(self, snap_compare):
"""Simple check that we can change the method."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+t")
await pilot.press("p")
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
class TestUrlBar:
def test_dropdown_appears_on_typing(self, snap_compare):
"""Check that the dropdown is filled with URLs."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press(*"http") # Move to the dropdown
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_dropdown_filters_on_typing(self, snap_compare):
"""Check that the dropdown filters on typing."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press(*"json") # Move to the dropdown
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_dropdown_completion_selected_via_enter_key(self, snap_compare):
"""Check that the dropdown completion is selected."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press(*"json") # Move to the dropdown
await pilot.press("enter") # Select the completion
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_dropdown_completion_selected_via_tab_key(self, snap_compare):
"""Check that the dropdown completion is selected."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press(*"json") # Move to the dropdown
await pilot.press("tab") # Select the completion
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
class TestCommandPalette:
@pytest.mark.parametrize("spacing", ["compact", "standard"])
def test_loads_and_shows_discovery_options(self, spacing, snap_compare):
"""Check that the command palette loads."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+p")
await disable_blink_for_active_cursors(pilot)
with patch_env("POSTING_SPACING", spacing):
assert snap_compare(
POSTING_MAIN, run_before=run_before, terminal_size=(120, 34)
)
def test_can_type_to_filter_options(self, snap_compare):
"""Check that we can run a command from the command palette."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+p")
await disable_blink_for_active_cursors(pilot)
await pilot.press(*"view")
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_can_run_command__hide_collection_browser(self, snap_compare):
"""Check that we can run a command from the command palette."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+p")
await disable_blink_for_active_cursors(pilot)
await pilot.press(*"tog coll")
await pilot.press("down", "enter")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestNewRequest:
def test_dialog_loads_and_can_be_used(self, snap_compare):
"""Check that the new request dialog loads and is prefilled
with the data based on where the cursor is."""
async def run_before(pilot: Pilot):
await pilot.press("J", "J", "ctrl+n")
await pilot.press(*"foo")
await pilot.press("tab", "tab")
await pilot.press(*"bar")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@pytest.mark.serial
def test_new_request_added_to_tree_correctly_and_notification_shown(
self, snap_compare
):
"""Check that the new request is added to the tree correctly
and that a notification is shown."""
async def run_before(pilot: Pilot):
await pilot.press("J", "J", "ctrl+n")
await pilot.press(*"foo")
await pilot.press("tab", "tab")
await pilot.press(*"bar")
await pilot.press("ctrl+n")
await pilot.pause()
await pilot.pause(2)
# Check the file exists
new_request_file = (
SAMPLE_COLLECTIONS / "jsonplaceholder" / "posts" / "foo.posting.yaml"
)
assert new_request_file.exists()
# Check the file content
assert (
new_request_file.read_text("utf-8")
== """\
name: foo
description: bar
"""
)
new_request_file.unlink()
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_cannot_create_request_without_name(self, snap_compare):
"""Check that we cannot create a request without a name.
We should see a validation error appear in the modal.
"""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+n")
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 34))
@pytest.mark.skip(reason="This test is flaky on CI - needs investigation.")
def test_cannot_create_request_with_duplicate_name(self, snap_compare):
"""Check that we cannot create a request with a duplicate name.
We expect to see an error toast at the bottom right.
"""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+n")
await pilot.press(*"echo") # this name already exists
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_cannot_create_request_invalid_filename(self, snap_compare):
"""Check that we cannot create a request with an invalid filename.
You should see a validation error next to the filename field.
"""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+n", "x", "tab")
await pilot.press(*"..")
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(88, 28))
def test_cannot_supply_invalid_path_in_collection(self, snap_compare):
"""Check that we cannot supply an invalid path in the collection.
You should see a validation error next to the filename field.
"""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+n", "x", "tab", "tab", "tab")
await pilot.press(*"../")
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(88, 28))
@use_config("general.yaml")
class TestUserInterfaceShortcuts:
def test_hide_collection_browser(self, snap_compare):
"""Check that we can hide the collection browser."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+h")
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_expand_request_section(self, snap_compare):
"""Check that we can expand the request section."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o") # jump mode
await pilot.press("q") # move focus to inside request section
await pilot.press("ctrl+m") # expand request section
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_expand_then_reset(self, snap_compare):
"""Check that we can expand the request section and then reset it."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o") # jump mode
await pilot.press("q") # move focus to inside request section
await pilot.press("ctrl+m") # expand request section
await pilot.press("ctrl+m") # reset sections
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestLoadingRequest:
def test_request_loaded_into_view__headers(self, snap_compare):
"""Check that the request headers are loaded into the view."""
async def run_before(pilot: Pilot):
# Navigate to 'get one post' and select it.
await pilot.press(*"Jj")
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 34))
def test_request_loaded_into_view__body(self, snap_compare):
"""Check that the request body is loaded into the view."""
async def run_before(pilot: Pilot):
# Navigate to 'POST one post' and select it.
await pilot.press(*"JJjjj")
await pilot.press("enter")
await pilot.press("ctrl+o", "w") # jump to 'Body' tab
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 34))
def test_request_loaded_into_view__query_params(self, snap_compare):
"""Check that the request query params are loaded into the view."""
async def run_before(pilot: Pilot):
# Navigate to 'GET comments via query' and select it.
await pilot.press(*"JJJjj")
await pilot.press("enter")
await pilot.press("ctrl+o", "r") # jump to 'Query Params' tab
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 34))
def test_request_loaded_into_view__auth(self, snap_compare):
"""Check that the request auth is loaded into the view."""
async def run_before(pilot: Pilot):
# Navigate to 'GET comments via query' and select it.
await pilot.press(*"jj")
await pilot.press("enter")
await pilot.press("ctrl+o", "t") # jump to 'Auth' tab
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 44))
def test_request_loaded_into_view__path_params(self, snap_compare):
"""Check that the request path params are loaded into the view."""
async def run_before(pilot: Pilot):
await pilot.press(*"jj")
await pilot.press("enter")
await pilot.press("ctrl+o", "e") # jump to 'Path Params' tab
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 34))
# @pytest.mark.skip(
# reason="info tab contains a path, specific to the host the test runs on"
# )
# def test_request_loaded_into_view__info(self, snap_compare):
# """Check that the request info is loaded into the view."""
# async def run_before(pilot: Pilot):
# await pilot.press("j")
# await pilot.press("enter")
# await pilot.press("ctrl+o", "t") # jump to 'Info' tab
# assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 44))
def test_request_loaded_into_view__options(self, snap_compare):
"""Check that the request options are loaded into the view."""
async def run_before(pilot: Pilot):
await pilot.press(*"jj")
await pilot.press("enter")
await pilot.press("ctrl+o", "i") # jump to 'Options' tab
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 44))
@use_config("general.yaml")
class TestHelpScreen:
def test_help_screen_appears(self, snap_compare):
"""Check that the help screen appears."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+question_mark")
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 42))
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestSave:
def test_no_request_selected__dialog_is_prefilled_correctly(self, snap_compare):
"""Check that the save dialog appears when no request is selected.
We should confirm that the New Request dialogue is open, and that the
information is pre-filled. Ensure that the filename is also computed
correctly for the `*.posting.yaml` file.
"""
async def run_before(pilot: Pilot):
await pilot.press(*"JJj")
await pilot.press("ctrl+o", "y") # select 'Info' tab
await pilot.press("j") # move down into 'Info' tab
await pilot.press(*"Foo: Bar")
await pilot.press("tab")
await pilot.press(*"baz")
await pilot.press("ctrl+s")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestSendRequest:
@pytest.mark.parametrize("spacing", ["compact", "standard"])
def test_send_request(self, spacing, snap_compare):
"""Check that we can send a request."""
async def run_before(pilot: Pilot):
await pilot.press(*"JJj") # select 'get one post'
await pilot.press("l") # testing 'l' to select
await pilot.press("ctrl+j") # send request
await pilot.app.workers.wait_for_complete()
with patch_env("POSTING_SPACING", spacing):
assert snap_compare(
POSTING_MAIN, run_before=run_before, terminal_size=(88, 34)
)
@use_config("modified_config.yaml")
class TestConfig:
def test_config(self, snap_compare):
"""Check that the config is loaded correctly.
The config loaded in this test class modifies the theme,
layout, focus on startup and response, and hides the header.
We should pay special attention to ensure the response body
is focused, as it should happen automatically when the response
is received based on this config.
"""
async def run_before(pilot: Pilot):
await pilot.press(*"JJj")
await pilot.press("l")
await pilot.press("ctrl+j")
await pilot.app.workers.wait_for_complete()
assert snap_compare(
POSTING_MAIN, run_before=run_before, terminal_size=(120, 34)
)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestVariables:
def test_unresolved_variables_highlighted(self, snap_compare):
"""Check that the unresolved variables are highlighted in the URL
and as a query parameter value."""
async def run_before(pilot: Pilot):
await pilot.press(*"JJJJj") # go to 'get one user'
await pilot.press("enter") # press 'enter' to select
await pilot.press("ctrl+o", "r") # go to 'Query' tab
await pilot.press("down") # move down into 'Query' tab
await pilot.press(*"foo", "enter") # pressing enter should shift to value
# The params typed below should be dimmed since they dont resolve
await pilot.press(*"$nope/${nope}")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@pytest.mark.parametrize("spacing", ["compact", "standard"])
def test_resolved_variables_highlight_and_preview(self, spacing, snap_compare):
"""Check that the resolved variables are highlighted in the URL
and the value is shown below."""
env_path = str((ENV_DIR / "sample_base.env").resolve())
with patch_env("POSTING_SPACING", spacing):
app = make_posting(
collection=SAMPLE_COLLECTIONS / "jsonplaceholder" / "todos",
env=(env_path,),
)
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.press("ctrl+l", "right")
assert snap_compare(app, run_before=run_before)
@use_config("custom_theme.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
@patch_env("POSTING_THEME_DIRECTORY", str(THEME_DIR.resolve()))
class TestCustomThemeSimple:
def test_theme_set_on_startup_and_in_command_palette(self, snap_compare):
"""Check that the theme is set on startup and available in the command palette."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+p")
await pilot.press(*"them", "enter")
await disable_blink_for_active_cursors(pilot)
await pilot.press(*"atest")
await pilot.pause()
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_theme_sensible_defaults__url(self, snap_compare):
"""This theme doesn't specify explicit values for the URL
or variable highlights, so we should expect sensible
defaults to be used. These defaults should be drawn from the
semantic colours defined in the theme.
"""
env_path = str((ENV_DIR / "sample_base.env").resolve())
app = make_posting(
collection=SAMPLE_COLLECTIONS / "jsonplaceholder" / "todos",
env=(env_path,),
)
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.press("ctrl+l", "right", *"/$lol/")
await pilot.press("ctrl+o", "w")
assert snap_compare(app, run_before=run_before, terminal_size=(100, 32))
def test_theme_sensible_defaults__json(self, snap_compare):
"""This theme doesn't explicitly declare JSON highlighting,
so lets ensure that sensible defaults are used.
"""
env_path = str((ENV_DIR / "sample_base.env").resolve())
app = make_posting(
collection=SAMPLE_COLLECTIONS / "jsonplaceholder",
env=(env_path,),
)
async def run_before(pilot: Pilot):
await pilot.press(*"jjj", "enter")
await pilot.press("ctrl+o", "w")
await pilot.press(*"jj")
await pilot.press("shift+down")
assert snap_compare(app, run_before=run_before, terminal_size=(100, 32))
@use_config("custom_theme2.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
@patch_env("POSTING_THEME_DIRECTORY", str(THEME_DIR.resolve()))
class TestCustomThemeComplex:
def test_highlighting_applied_from_custom_theme__url(self, snap_compare):
"""Ensure custom theme is applied correctly in the URL bar.
Resolved and unresolved variables should be highlighted based on the
theme. The chosen theme has some funky choices for the URL, so it should
be clear that the URL protocol, base, and separators are being highlighted
as expected.
"""
env_path = str((ENV_DIR / "sample_base.env").resolve())
app = make_posting(
collection=SAMPLE_COLLECTIONS / "jsonplaceholder" / "todos",
env=(env_path,),
)
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.press("ctrl+l", "right", *"/$lol/")
await pilot.press("ctrl+o", "w")
assert snap_compare(app, run_before=run_before, terminal_size=(100, 32))
def test_highlighting_applied_from_custom_theme__json(self, snap_compare):
"""Ensure custom theme is applied correctly to TextAreas.
Ensure the gutter is coloured both foreground and background.
The cursor line and selection should also be coloured.
Ensure the JSON is being highlighted as expected - we would
expect the colours of JSON keys and values to match those of the
overall theme.
"""
env_path = str((ENV_DIR / "sample_base.env").resolve())
app = make_posting(
collection=SAMPLE_COLLECTIONS / "jsonplaceholder",
env=(env_path,),
)
async def run_before(pilot: Pilot):
await pilot.press(*"jjj", "enter")
await pilot.press("ctrl+o", "w")
await pilot.press(*"jj")
await pilot.press("shift+down")
assert snap_compare(app, run_before=run_before, terminal_size=(100, 32))
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestFocusAutoSwitchingConfig:
@pytest.mark.parametrize(
"focus_target",
[
"headers",
"body",
"query",
"url",
"method",
], # TODO: "info" has been removed, the path field causes test fails on CI
)
def test_focus_on_request_open__open_body(
self,
focus_target,
monkeypatch,
snap_compare,
):
"""Check that the expected tab is focused when a request is opened from the collection browser."""
monkeypatch.setenv("POSTING_FOCUS__ON_REQUEST_OPEN", focus_target)
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.pause() # wait for focus to switch
await pilot.wait_for_scheduled_animations()
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 60))
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestDisableRowInTable:
def test_disable_row_in_table(self, snap_compare):
"""Check that a row can be disabled in a table."""
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.press("ctrl+o", "q")
await pilot.press("j", "j", "space", "j")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@pytest.mark.skip(
reason="These tests are flaky on CI as the notification doesnt show up."
)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestCurlExport:
def test_curl_export_no_setup(self, snap_compare):
"""Check that the curl export works when setup scripts are not run."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press("enter")
await pilot.press("ctrl+p", *"curl no setup", "enter")
await pilot.pause()
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_curl_export(self, snap_compare):
"""Check that the curl export works correctly."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press("enter")
await pilot.press("ctrl+p", *"curl", "enter")
await pilot.pause()
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestScripts:
def test_script_runs(self, snap_compare):
"""Check that a script runs correctly."""
async def run_before(pilot: Pilot):
await pilot.pause()
await pilot.press("enter")
await pilot.press("ctrl+j")
await pilot.app.workers.wait_for_complete()
await pilot.press("ctrl+o", "f") # jump to "Scripts"
await pilot.press("ctrl+m") # expand response section
assert snap_compare(POSTING_MAIN, run_before=run_before, terminal_size=(80, 34))
@use_config("general.yaml")
class TestHeaderAutoCompletion:
def test_header_name_auto_completion_list_appears(self, snap_compare):
"""Check that the header name auto completion list appears."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o", "q", "j", *"acc")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@pytest.mark.parametrize("key", ["tab", "enter", "escape"])
def test_header_name_auto_completion_list_appears_followed_by_keypress(
self, key: str, snap_compare
):
"""Check that the header name auto completion list appears and users can complete it.
If the key is enter, the completion should be selected and focus should remain in the name field.
If the key is tab, the completion should be selected and focus should move to the value field.
If the key is escape, the completion list should be closed and focus should remain in the name field.
"""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o", "q", "j", *"acc", key)
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_header_value_auto_completion_list_appears(self, snap_compare):
"""Check that the header value auto completion list appears."""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o", "q", "j", *"CType", "tab")
await pilot.press(*"ajs")
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_header_value_auto_completion_list_accepts_selection(self, snap_compare):
"""Check that the header value auto completion list accepts selection.
Expect to see `application/json` in the value field for the header.
"""
async def run_before(pilot: Pilot):
await pilot.press("ctrl+o", "q", "j", *"CType", "tab")
await pilot.press(*"ajs")
await pilot.press("enter")
assert snap_compare(POSTING_MAIN, run_before=run_before)
@use_config("general.yaml")
@patch_env("POSTING_FOCUS__ON_STARTUP", "collection")
class TestEditKeyValues:
def test_edit_mode_displays_correctly(self, snap_compare):
"""Check that the UI looks correct when entering edit mode.
In this test, we're editing the first header row.
"""
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.press("ctrl+o", "q") # Select "Headers" tab
await pilot.press("down")
await pilot.press("enter") # Begin editing the first header
assert snap_compare(POSTING_MAIN, run_before=run_before)
def test_edit_mode_can_edit_header_keys_and_values_as_expected(self, snap_compare):
"""The name of the first header should be X-Forwarded-For, and the value should be foo."""
async def run_before(pilot: Pilot):
await pilot.press("j", "j", "enter")
await pilot.press("ctrl+o", "q") # Select "Headers" tab
await pilot.press("down")
await pilot.press("enter") # Begin editing the first header
await pilot.press(
"x", "enter"
) # Accept the completion of "X-Forwarded-For"
await pilot.press("tab") # Move focus to the value field
await pilot.press(*"foo") # Change the value to "foo"
await pilot.press("enter") # Accept the change
assert snap_compare(POSTING_MAIN, run_before=run_before)
================================================
FILE: tests/test_urls.py
================================================
from posting.urls import (
ensure_protocol,
extract_path_param_names,
substitute_path_params,
)
def test_ensure_protocol():
assert ensure_protocol("example.com") == "http://example.com"
assert ensure_protocol("https://example.com") == "https://example.com"
assert ensure_protocol("http://example.com") == "http://example.com"
assert ensure_protocol("ftp://example.com") == "ftp://example.com"
assert ensure_protocol("localhost:8000") == "http://localhost:8000"
assert ensure_protocol("localhost") == "http://localhost"
assert ensure_protocol("localhost:8000/path") == "http://localhost:8000/path"
assert ensure_protocol("localhost/path") == "http://localhost/path"
assert (
ensure_protocol("localhost:8000/path/to/resource")
== "http://localhost:8000/path/to/resource"
)
def test_extract_path_param_names_with_escaping():
assert extract_path_param_names("/users/:id") == ["id"]
assert extract_path_param_names("/users/::id") == []
assert extract_path_param_names("/users/::id/:id") == ["id"]
assert extract_path_param_names("http://example.com/a/::literal/:name/b") == [
"name"
]
def test_substitute_path_params_with_escaping_simple():
url = "http://example.com/users/:id"
out = substitute_path_params(url, {"id": "123"})
assert out == "http://example.com/users/123"
def test_substitute_path_params_preserves_escaped_literal():
url = "http://example.com/users/::id"
out = substitute_path_params(url, {"id": "123"})
# Escaped token should remain literal ":id" in the path
assert out == "http://example.com/users/:id"
def test_substitute_path_params_mixed_escaped_and_real():
url = "http://example.com/users/::id/:id/details"
out = substitute_path_params(url, {"id": "123"})
assert out == "http://example.com/users/:id/123/details"
================================================
FILE: tests/test_variables.py
================================================
import pytest
from posting.variables import find_variables, variable_range_at_cursor
@pytest.mark.parametrize(
"text, expected",
[
("", []), # Empty string
("hello", []), # No variables
("Hello, $name!", [("name", 7, 12)]), # Single var
("Hello, $name! $age", [("name", 7, 12), ("age", 14, 18)]), # Multiple vars
("Hello, $$foo $bar", [("bar", 13, 17)]), # Escaped vars
("$hello", [("hello", 0, 6)]), # Single var at start
("$", []), # Empty var name
("$$", []), # No variables
("${hello}", [("hello", 0, 8)]), # Variable with braces
(
"${hello} ${world}",
[("hello", 0, 8), ("world", 9, 17)],
), # Multiple vars with braces
("$${hello}", []), # Escaped braces
("${}", []), # Empty braces
],
)
def test_find_variables(text: str, expected: list[tuple[str, int, int]]):
assert find_variables(text) == expected
@pytest.mark.parametrize(
"text, cursor, expected",
[
# Basic checks
("", 0, None),
("", 1, None), # Out of bounds
("", -1, None), # Out of bounds
("Hello, $name!", 0, None),
("Hello, $name!", 7, None),
("Hello, $name!", 8, (7, 12)),
("Hello, $name!", 9, (7, 12)),
("Hello, $name!", 10, (7, 12)),
("Hello, $name!", 11, (7, 12)),
("Hello, $name!", 12, None),
("Hello, $name!", 13, None),
# Escaped variables
("Hello, $$name!", 0, None),
("Hello, $$name!", 7, None),
("Hello, $$name!", 8, None),
("Hello, $$name!", 9, None),
("Hello, $$name!", 10, None),
("Hello, $$name!", 11, None),
("Hello, $$name!", 12, None),
# Braces
("${}", 0, None),
("${name}", 0, None),
("${name}", 1, (0, 7)),
("${name}", 2, (0, 7)),
# Empty Braces
("${}", 0, None),
("${}", 1, None),
("${}", -1, None),
("${}", 2, None),
("${}", 3, None),
# Escaped braces
("$${name}", 0, None),
("$${name}", 1, None),
("$${name}", 2, None),
("$${name}", 3, None),
("$${name}", 4, None),
("$${name}", 5, None),
],
)
def test_variable_range_at_cursor(
text: str, cursor: int, expected: tuple[int, int] | None
):
assert variable_range_at_cursor(cursor, text) == expected
backend default {\\n .host = "127.0.0.1";\\n .port = "80";\\n}\\nsub vcl_recv {\\n set req.backend = default;\\n}\\nsub vcl_hash {\\n set req.hash += req.url;\\n set req.hash += req.http.host;\\n set req.hash += "0";\\n}\\n\\n