You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/api/auth/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ You'll find this API key in your [Account Settings](https://pipedream.com/settin
12
12
13
13
Pipedream uses [Bearer Authentication](https://oauth.net/2/bearer-tokens/) to authorize your access to the API or SSE event streams. When you make API requests, pass an `Authorization` header of the following format:
Copy file name to clipboardExpand all lines: docs/docs/api/rest/README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ The base URL for all requests is **{{$site.themeConfig.API_BASE_URL}}** .
18
18
19
19
Pipedream uses [Bearer Authentication](https://oauth.net/2/bearer-tokens/) to authorize your access to the API. When you make API requests, pass an `Authorization` header of the following format:
20
20
21
-
```text
21
+
```
22
22
Authorization: Bearer <api key>
23
23
```
24
24
@@ -151,7 +151,7 @@ Retrieve information on the authenticated user.
151
151
152
152
**Endpoint**
153
153
154
-
```text
154
+
```
155
155
GET /users/me
156
156
```
157
157
@@ -195,7 +195,7 @@ This route returns the components `id`, `code`, `configurable_props`, and other
195
195
196
196
**Endpoint**
197
197
198
-
```text
198
+
```
199
199
POST /components
200
200
```
201
201
@@ -267,7 +267,7 @@ Retrieve a component by ID to determine its metadata and configurable props.
@@ -459,7 +459,7 @@ Example response from creating an RSS source that runs once a minute:
459
459
460
460
**Endpoint**
461
461
462
-
```text
462
+
```
463
463
PUT /sources/{id}
464
464
```
465
465
@@ -511,7 +511,7 @@ Default: `true`.
511
511
512
512
**Endpoint**
513
513
514
-
```text
514
+
```
515
515
DELETE /sources/{id}
516
516
```
517
517
@@ -529,7 +529,7 @@ You can configure a source, or a workflow, to receive events from any number of
529
529
530
530
**Endpoint**
531
531
532
-
```text
532
+
```
533
533
POST /subscriptions?emitter_id={emitting_component_id}&listener_id={receiving_source_id}
534
534
```
535
535
@@ -574,21 +574,21 @@ Retrieve up to the last 100 events emitted by a source.
574
574
575
575
**Endpoint**
576
576
577
-
```text
577
+
```
578
578
GET /sources/{id}/event_summaries
579
579
```
580
580
581
581
**Notes and Examples**
582
582
583
583
The event data for events larger than `1KB` may get truncated in the response. If you're processing larger events, and need to see the full event data, pass `?expand=event`:
584
584
585
-
```text
585
+
```
586
586
GET /sources/{id}/event_summaries?expand=event
587
587
```
588
588
589
589
Pass `?limit=N` to retrieve the last **N** events:
590
590
591
-
```text
591
+
```
592
592
GET /sources/{id}/event_summaries?limit=10
593
593
```
594
594
@@ -604,7 +604,7 @@ These IDs can be retrieved by using the [`GET /sources/{id}/event_summaries` end
Copy file name to clipboardExpand all lines: docs/docs/cli/login/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ To start using the Pipedream CLI, you'll need to link it to your Pipedream accou
8
8
9
9
If you already have a Pipedream account, run
10
10
11
-
```text
11
+
```
12
12
pd login
13
13
```
14
14
@@ -18,7 +18,7 @@ Otherwise, you'll be asked to login.
18
18
19
19
Once you're done, go back to your shell and you should see confirmation that your account is linked:
20
20
21
-
```text
21
+
```
22
22
> pd login
23
23
Logged in as dylburger (dylan@pipedream.com)
24
24
```
@@ -27,15 +27,15 @@ Logged in as dylburger (dylan@pipedream.com)
27
27
28
28
If you haven't signed up for a Pipedream account, you can create an account using the CLI:
29
29
30
-
```text
30
+
```
31
31
pd signup
32
32
```
33
33
34
34
This will open up a new window in your default browser. You'll be asked to sign up for Pipedream here. Once you do, your account will be linked to the CLI, writing your API key for that account to your [`pd` config file](/cli/reference/#cli-config-file).
35
35
36
36
Once you're done, go back to your shell and you should see confirmation that your account is linked:
37
37
38
-
```text
38
+
```
39
39
> pd signup
40
40
Logged in as dylburger (dylan@pipedream.com)
41
41
```
@@ -44,7 +44,7 @@ Logged in as dylburger (dylan@pipedream.com)
Copy file name to clipboardExpand all lines: docs/docs/cli/reference/README.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Since this is a preview release, the commands you see below, and the [REST API](
14
14
15
15
To install the CLI, run:
16
16
17
-
```text
17
+
```
18
18
curl https://cli.pipedream.com/install | sh
19
19
```
20
20
@@ -34,7 +34,7 @@ We've also documented each command below, with usage examples for each.
34
34
35
35
Everywhere you can refer to a specific source as an argument, you can use the source's ID _or_ its name slug. For example, to retrieve details about a specific source using `pd describe`, you can use either of the following commands:
36
36
37
-
```text
37
+
```
38
38
λ ~/ pd describe dc_abc123
39
39
40
40
id: dc_abc123
@@ -53,7 +53,7 @@ Searching for sources matching http
53
53
54
54
Deletes an event source. Run:
55
55
56
-
```text
56
+
```
57
57
pd describe <source-id-or-name>
58
58
```
59
59
@@ -69,13 +69,13 @@ When you select a source, we'll deploy it and start listening for new events.
69
69
70
70
You can also deploy a specific source via Github URL:
or author a component locally and deploy that local file:
77
77
78
-
```text
78
+
```
79
79
pd deploy http.js
80
80
```
81
81
@@ -85,33 +85,33 @@ pd deploy http.js
85
85
86
86
Display the details for a source: its id, name, and other configuration details:
87
87
88
-
```text
88
+
```
89
89
pd describe <source-id-or-name>
90
90
```
91
91
92
92
### `pd events`
93
93
94
94
Returns historical events sent to a source, and streams emitted events directly to the CLI.
95
95
96
-
```text
96
+
```
97
97
pd events <source-id-or-name>
98
98
```
99
99
100
100
By default, `pd events` prints (up to) the last 10 events sent to your source.
101
101
102
-
```text
102
+
```
103
103
pd events -n 100 <source-id-or-name>
104
104
```
105
105
106
106
`pd events -n N` retrieves the last `N` events sent to your source. We store the last 100 events sent to a source, so you can retrieve a max of 100 events using this command.
107
107
108
-
```text
108
+
```
109
109
pd events -f <source-id-or-name>
110
110
```
111
111
112
112
`pd events -f` connects to the [SSE stream tied to your source](/api/sse/) and displays events as the source produces them.
113
113
114
-
```text
114
+
```
115
115
pd events -n N -f <source-id-or-name>
116
116
```
117
117
@@ -127,21 +127,21 @@ Lists Pipedream resources you own. Running `pd list` without any arguments promp
127
127
128
128
You can also list specific resource types directly:
129
129
130
-
```text
130
+
```
131
131
pd list sources
132
132
```
133
133
134
-
```text
134
+
```
135
135
pd list streams
136
136
```
137
137
138
138
`sources` and `streams` have shorter aliases, too:
139
139
140
-
```text
140
+
```
141
141
pd list so
142
142
```
143
143
144
-
```text
144
+
```
145
145
pd list st
146
146
```
147
147
@@ -157,7 +157,7 @@ Running `pd logout` without any arguments removes the default API key from your
157
157
158
158
You can remove the API key for a specific profile by running:
159
159
160
-
```text
160
+
```
161
161
pd logout -p <profile>
162
162
```
163
163
@@ -179,25 +179,25 @@ Updates the code, props, or metadata for an event source.
179
179
180
180
If you deployed a source from Github, for example, someone might publish an update to that source, and you may want to run the updated code.
You can deactivate a source if you want to stop it from running:
193
193
194
-
```text
194
+
```
195
195
pd update <source-id-or-name> --deactivate
196
196
```
197
197
198
198
or activate a source you previously deactivated:
199
199
200
-
```text
200
+
```
201
201
pd update <source-id-or-name> --activate
202
202
```
203
203
@@ -209,19 +209,19 @@ Profiles allow you to work with multiple, named Pipedream accounts via the CLI.
209
209
210
210
When you [login to the CLI](/cli/login/), the CLI writes the API key for that account to your config file, in the `api_key` field:
211
211
212
-
```text
212
+
```
213
213
api_key = abc123
214
214
```
215
215
216
216
You can set API keys for other, named profiles, too. Run
217
217
218
-
```text
218
+
```
219
219
pd login -p <profile>
220
220
```
221
221
222
222
`<profile>` can be any string of shell-safe characters that you'd like to use to identify this new profile. The CLI opens up a browser asking you to login to your target Pipedream account, then writes the API key to a section of the config file under this profile:
223
223
224
-
```text
224
+
```
225
225
[your_profile]
226
226
api_key = def456
227
227
```
@@ -232,15 +232,15 @@ You can also run `pd signup -p <profile>` if you'd like to sign up for a new Pip
232
232
233
233
You can set a profile on any `pd` command by setting the `-p` or `--profile` flag. For example, to list the sources in a specific account, run:
0 commit comments