Skip to content

Commit 8bc5666

Browse files
authored
Add new configuration document for connection urlscan (#121)
1 parent dcf9209 commit 8bc5666

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: urlscan
3+
sidebar_label: urlscan
4+
---
5+
6+
# urlscan
7+
8+
The `urlscan` connection can be used to access URLScan resources.
9+
10+
```hcl
11+
connection "urlscan" "my_urlscan" {
12+
api_key = "11111111-e127-1234-adcd-59cad2f12abc"
13+
}
14+
```
15+
16+
## Arguments
17+
18+
| Name | Type | Required? | Description |
19+
| --------- | ------ | --------- | ----------- |
20+
| `api_key` | String | Optional | API Key |
21+
22+
All arguments are optional, and a `urlscan` connection with no arguments will behave the same as the [default connection](#default-connection).
23+
24+
## Attributes (Read-Only)
25+
26+
| Attribute | Type | Description |
27+
| --------- | ---- | ---------------------------------------------------------------------------------- |
28+
| `env` | Map | A map of the resolved connection-related environment variables (`URLSCAN_API_KEY`) |
29+
30+
## Default Connection
31+
32+
The `urlscan` connection type includes an implicit, default connection (`connection.urlscan.default`) that will be configured to set the `api_key` to the `URLSCAN_API_KEY` environment variable.
33+
34+
```hcl
35+
connection "urlscan" "default" {
36+
api_key = env("URLSCAN_API_KEY")
37+
}
38+
```

0 commit comments

Comments
 (0)