@townco/fly 0.1.72 → 0.1.74
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/dist/client/client.gen.d.ts +0 -2
- package/dist/client/client.gen.js +0 -228
- package/dist/client/index.d.ts +0 -8
- package/dist/client/index.js +0 -6
- package/dist/client/types.gen.d.ts +0 -117
- package/dist/client/types.gen.js +0 -2
- package/dist/client/utils.gen.d.ts +0 -33
- package/dist/client/utils.gen.js +0 -231
- package/dist/client.gen.d.ts +0 -12
- package/dist/client.gen.js +0 -3
- package/dist/core/auth.gen.d.ts +0 -18
- package/dist/core/auth.gen.js +0 -14
- package/dist/core/bodySerializer.gen.d.ts +0 -25
- package/dist/core/bodySerializer.gen.js +0 -57
- package/dist/core/params.gen.d.ts +0 -43
- package/dist/core/params.gen.js +0 -100
- package/dist/core/pathSerializer.gen.d.ts +0 -33
- package/dist/core/pathSerializer.gen.js +0 -114
- package/dist/core/queryKeySerializer.gen.d.ts +0 -18
- package/dist/core/queryKeySerializer.gen.js +0 -99
- package/dist/core/serverSentEvents.gen.d.ts +0 -71
- package/dist/core/serverSentEvents.gen.js +0 -135
- package/dist/core/types.gen.d.ts +0 -78
- package/dist/core/types.gen.js +0 -2
- package/dist/core/utils.gen.d.ts +0 -19
- package/dist/core/utils.gen.js +0 -87
- package/dist/sdk.gen.d.ts +0 -379
- package/dist/sdk.gen.js +0 -557
- package/dist/types.gen.d.ts +0 -2592
- package/dist/types.gen.js +0 -2
package/dist/sdk.gen.d.ts
DELETED
|
@@ -1,379 +0,0 @@
|
|
|
1
|
-
import type { Client, Options as Options2, TDataShape } from "./client";
|
|
2
|
-
import type { AppCreateDeployTokenData, AppCreateDeployTokenResponses, AppIpAssignmentsCreateData, AppIpAssignmentsCreateResponses, AppIpAssignmentsDeleteData, AppIpAssignmentsDeleteResponses, AppIpAssignmentsListData, AppIpAssignmentsListResponses, AppsCreateData, AppsCreateErrors, AppsCreateResponses, AppsDeleteData, AppsDeleteResponses, AppsListData, AppsListResponses, AppsShowData, AppsShowResponses, CreateVolumeSnapshotData, CreateVolumeSnapshotResponses, CurrentTokenShowData, CurrentTokenShowErrors, CurrentTokenShowResponses, MachinesCordonData, MachinesCordonResponses, MachinesCreateData, MachinesCreateLeaseData, MachinesCreateLeaseResponses, MachinesCreateResponses, MachinesDeleteData, MachinesDeleteMetadataData, MachinesDeleteMetadataResponses, MachinesDeleteResponses, MachinesExecData, MachinesExecErrors, MachinesExecResponses, MachinesListData, MachinesListEventsData, MachinesListEventsResponses, MachinesListProcessesData, MachinesListProcessesErrors, MachinesListProcessesResponses, MachinesListResponses, MachinesListVersionsData, MachinesListVersionsResponses, MachinesPatchMetadataData, MachinesPatchMetadataErrors, MachinesPatchMetadataResponses, MachinesReclaimMemoryData, MachinesReclaimMemoryResponses, MachinesReleaseLeaseData, MachinesReleaseLeaseResponses, MachinesRestartData, MachinesRestartErrors, MachinesRestartResponses, MachinesShowData, MachinesShowLeaseData, MachinesShowLeaseResponses, MachinesShowMetadataData, MachinesShowMetadataResponses, MachinesShowResponses, MachinesSignalData, MachinesSignalErrors, MachinesSignalResponses, MachinesStartData, MachinesStartResponses, MachinesStopData, MachinesStopErrors, MachinesStopResponses, MachinesSuspendData, MachinesSuspendResponses, MachinesUncordonData, MachinesUncordonResponses, MachinesUpdateData, MachinesUpdateErrors, MachinesUpdateMetadataData, MachinesUpdateMetadataErrors, MachinesUpdateMetadataResponses, MachinesUpdateResponses, MachinesWaitData, MachinesWaitErrors, MachinesWaitResponses, PlatformPlacementsPostData, PlatformPlacementsPostResponses, PlatformRegionsGetData, PlatformRegionsGetResponses, SecretCreateData, SecretCreateErrors, SecretCreateResponses, SecretDeleteData, SecretDeleteResponses, SecretGetData, SecretGetResponses, SecretkeyDecryptData, SecretkeyDecryptErrors, SecretkeyDecryptResponses, SecretkeyDeleteData, SecretkeyDeleteResponses, SecretkeyEncryptData, SecretkeyEncryptErrors, SecretkeyEncryptResponses, SecretkeyGenerateData, SecretkeyGenerateErrors, SecretkeyGenerateResponses, SecretkeyGetData, SecretkeyGetResponses, SecretkeySetData, SecretkeySetErrors, SecretkeySetResponses, SecretkeySignData, SecretkeySignErrors, SecretkeySignResponses, SecretkeysListData, SecretkeysListResponses, SecretkeyVerifyData, SecretkeyVerifyErrors, SecretkeyVerifyResponses, SecretsListData, SecretsListResponses, SecretsUpdateData, SecretsUpdateErrors, SecretsUpdateResponses, TokensRequestKmsData, TokensRequestKmsResponses, TokensRequestOidcData, TokensRequestOidcErrors, TokensRequestOidcResponses, VolumeDeleteData, VolumeDeleteResponses, VolumesCreateData, VolumesCreateResponses, VolumesExtendData, VolumesExtendResponses, VolumesGetByIdData, VolumesGetByIdResponses, VolumesListData, VolumesListResponses, VolumesListSnapshotsData, VolumesListSnapshotsResponses, VolumesUpdateData, VolumesUpdateErrors, VolumesUpdateResponses } from "./types.gen";
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
-
/**
|
|
5
|
-
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
-
* individual options. This might be also useful if you want to implement a
|
|
7
|
-
* custom client.
|
|
8
|
-
*/
|
|
9
|
-
client?: Client;
|
|
10
|
-
/**
|
|
11
|
-
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
-
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
-
*/
|
|
14
|
-
meta?: Record<string, unknown>;
|
|
15
|
-
};
|
|
16
|
-
/**
|
|
17
|
-
* List Apps
|
|
18
|
-
*
|
|
19
|
-
* List all apps with the ability to filter by organization slug.
|
|
20
|
-
*
|
|
21
|
-
*/
|
|
22
|
-
export declare const appsList: <ThrowOnError extends boolean = false>(options: Options<AppsListData, ThrowOnError>) => import("./client").RequestResult<AppsListResponses, unknown, ThrowOnError, "fields">;
|
|
23
|
-
/**
|
|
24
|
-
* Create App
|
|
25
|
-
*
|
|
26
|
-
* Create an app with the specified details in the request body.
|
|
27
|
-
*
|
|
28
|
-
*/
|
|
29
|
-
export declare const appsCreate: <ThrowOnError extends boolean = false>(options: Options<AppsCreateData, ThrowOnError>) => import("./client").RequestResult<AppsCreateResponses, AppsCreateErrors, ThrowOnError, "fields">;
|
|
30
|
-
/**
|
|
31
|
-
* Destroy App
|
|
32
|
-
*
|
|
33
|
-
* Delete an app by its name.
|
|
34
|
-
*
|
|
35
|
-
*/
|
|
36
|
-
export declare const appsDelete: <ThrowOnError extends boolean = false>(options: Options<AppsDeleteData, ThrowOnError>) => import("./client").RequestResult<AppsDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
37
|
-
/**
|
|
38
|
-
* Get App
|
|
39
|
-
*
|
|
40
|
-
* Retrieve details about a specific app by its name.
|
|
41
|
-
*
|
|
42
|
-
*/
|
|
43
|
-
export declare const appsShow: <ThrowOnError extends boolean = false>(options: Options<AppsShowData, ThrowOnError>) => import("./client").RequestResult<AppsShowResponses, unknown, ThrowOnError, "fields">;
|
|
44
|
-
/**
|
|
45
|
-
* Create App deploy token
|
|
46
|
-
*/
|
|
47
|
-
export declare const appCreateDeployToken: <ThrowOnError extends boolean = false>(options: Options<AppCreateDeployTokenData, ThrowOnError>) => import("./client").RequestResult<AppCreateDeployTokenResponses, unknown, ThrowOnError, "fields">;
|
|
48
|
-
/**
|
|
49
|
-
* List IP assignments for app
|
|
50
|
-
*/
|
|
51
|
-
export declare const appIpAssignmentsList: <ThrowOnError extends boolean = false>(options?: Options<AppIpAssignmentsListData, ThrowOnError>) => import("./client").RequestResult<AppIpAssignmentsListResponses, unknown, ThrowOnError, "fields">;
|
|
52
|
-
/**
|
|
53
|
-
* Assign new IP address to app
|
|
54
|
-
*/
|
|
55
|
-
export declare const appIpAssignmentsCreate: <ThrowOnError extends boolean = false>(options: Options<AppIpAssignmentsCreateData, ThrowOnError>) => import("./client").RequestResult<AppIpAssignmentsCreateResponses, unknown, ThrowOnError, "fields">;
|
|
56
|
-
/**
|
|
57
|
-
* Remove IP assignment from app
|
|
58
|
-
*/
|
|
59
|
-
export declare const appIpAssignmentsDelete: <ThrowOnError extends boolean = false>(options?: Options<AppIpAssignmentsDeleteData, ThrowOnError>) => import("./client").RequestResult<AppIpAssignmentsDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
60
|
-
/**
|
|
61
|
-
* List Machines
|
|
62
|
-
*
|
|
63
|
-
* List all Machines associated with a specific app, with optional filters for including deleted Machines and filtering by region.
|
|
64
|
-
*
|
|
65
|
-
*/
|
|
66
|
-
export declare const machinesList: <ThrowOnError extends boolean = false>(options: Options<MachinesListData, ThrowOnError>) => import("./client").RequestResult<MachinesListResponses, unknown, ThrowOnError, "fields">;
|
|
67
|
-
/**
|
|
68
|
-
* Create Machine
|
|
69
|
-
*
|
|
70
|
-
* Create a Machine within a specific app using the details provided in the request body.
|
|
71
|
-
*
|
|
72
|
-
* **Important**: This request can fail, and you’re responsible for handling that failure. If you ask for a large Machine, or a Machine in a region we happen to be at capacity for, you might need to retry the request, or to fall back to another region. If you’re working directly with the Machines API, you’re taking some responsibility for your own orchestration!
|
|
73
|
-
*
|
|
74
|
-
*/
|
|
75
|
-
export declare const machinesCreate: <ThrowOnError extends boolean = false>(options: Options<MachinesCreateData, ThrowOnError>) => import("./client").RequestResult<MachinesCreateResponses, unknown, ThrowOnError, "fields">;
|
|
76
|
-
/**
|
|
77
|
-
* Destroy Machine
|
|
78
|
-
*
|
|
79
|
-
* Delete a specific Machine within an app by Machine ID, with an optional force parameter to force kill the Machine if it's running.
|
|
80
|
-
*
|
|
81
|
-
*/
|
|
82
|
-
export declare const machinesDelete: <ThrowOnError extends boolean = false>(options: Options<MachinesDeleteData, ThrowOnError>) => import("./client").RequestResult<MachinesDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
83
|
-
/**
|
|
84
|
-
* Get Machine
|
|
85
|
-
*
|
|
86
|
-
* Get details of a specific Machine within an app by the Machine ID.
|
|
87
|
-
*
|
|
88
|
-
*/
|
|
89
|
-
export declare const machinesShow: <ThrowOnError extends boolean = false>(options: Options<MachinesShowData, ThrowOnError>) => import("./client").RequestResult<MachinesShowResponses, unknown, ThrowOnError, "fields">;
|
|
90
|
-
/**
|
|
91
|
-
* Update Machine
|
|
92
|
-
*
|
|
93
|
-
* Update a Machine's configuration using the details provided in the request body.
|
|
94
|
-
*
|
|
95
|
-
*/
|
|
96
|
-
export declare const machinesUpdate: <ThrowOnError extends boolean = false>(options: Options<MachinesUpdateData, ThrowOnError>) => import("./client").RequestResult<MachinesUpdateResponses, MachinesUpdateErrors, ThrowOnError, "fields">;
|
|
97
|
-
/**
|
|
98
|
-
* Cordon Machine
|
|
99
|
-
*
|
|
100
|
-
* “Cordoning” a Machine refers to disabling its services, so the Fly Proxy won’t route requests to it. In flyctl this is used by blue/green deployments; one set of Machines is started up with services disabled, and when they are all healthy, the services are enabled on the new Machines and disabled on the old ones.
|
|
101
|
-
*
|
|
102
|
-
*/
|
|
103
|
-
export declare const machinesCordon: <ThrowOnError extends boolean = false>(options: Options<MachinesCordonData, ThrowOnError>) => import("./client").RequestResult<MachinesCordonResponses, unknown, ThrowOnError, "fields">;
|
|
104
|
-
/**
|
|
105
|
-
* List Events
|
|
106
|
-
*
|
|
107
|
-
* List all events associated with a specific Machine within an app.
|
|
108
|
-
*
|
|
109
|
-
*/
|
|
110
|
-
export declare const machinesListEvents: <ThrowOnError extends boolean = false>(options: Options<MachinesListEventsData, ThrowOnError>) => import("./client").RequestResult<MachinesListEventsResponses, unknown, ThrowOnError, "fields">;
|
|
111
|
-
/**
|
|
112
|
-
* Execute Command
|
|
113
|
-
*
|
|
114
|
-
* Execute a command on a specific Machine and return the raw command output bytes.
|
|
115
|
-
*
|
|
116
|
-
*/
|
|
117
|
-
export declare const machinesExec: <ThrowOnError extends boolean = false>(options: Options<MachinesExecData, ThrowOnError>) => import("./client").RequestResult<MachinesExecResponses, MachinesExecErrors, ThrowOnError, "fields">;
|
|
118
|
-
/**
|
|
119
|
-
* Release Lease
|
|
120
|
-
*
|
|
121
|
-
* Release the lease of a specific Machine within an app. Machine leases can be used to obtain an exclusive lock on modifying a Machine.
|
|
122
|
-
*
|
|
123
|
-
*/
|
|
124
|
-
export declare const machinesReleaseLease: <ThrowOnError extends boolean = false>(options: Options<MachinesReleaseLeaseData, ThrowOnError>) => import("./client").RequestResult<MachinesReleaseLeaseResponses, unknown, ThrowOnError, "fields">;
|
|
125
|
-
/**
|
|
126
|
-
* Get Lease
|
|
127
|
-
*
|
|
128
|
-
* Retrieve the current lease of a specific Machine within an app. Machine leases can be used to obtain an exclusive lock on modifying a Machine.
|
|
129
|
-
*
|
|
130
|
-
*/
|
|
131
|
-
export declare const machinesShowLease: <ThrowOnError extends boolean = false>(options: Options<MachinesShowLeaseData, ThrowOnError>) => import("./client").RequestResult<MachinesShowLeaseResponses, unknown, ThrowOnError, "fields">;
|
|
132
|
-
/**
|
|
133
|
-
* Create Lease
|
|
134
|
-
*
|
|
135
|
-
* Create a lease for a specific Machine within an app using the details provided in the request body. Machine leases can be used to obtain an exclusive lock on modifying a Machine.
|
|
136
|
-
*
|
|
137
|
-
*/
|
|
138
|
-
export declare const machinesCreateLease: <ThrowOnError extends boolean = false>(options: Options<MachinesCreateLeaseData, ThrowOnError>) => import("./client").RequestResult<MachinesCreateLeaseResponses, unknown, ThrowOnError, "fields">;
|
|
139
|
-
/**
|
|
140
|
-
* Reclaim Machine Memory
|
|
141
|
-
*
|
|
142
|
-
* Trigger the balloon device to reclaim memory from a machine
|
|
143
|
-
*/
|
|
144
|
-
export declare const machinesReclaimMemory: <ThrowOnError extends boolean = false>(options: Options<MachinesReclaimMemoryData, ThrowOnError>) => import("./client").RequestResult<MachinesReclaimMemoryResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
-
/**
|
|
146
|
-
* Get Metadata
|
|
147
|
-
*
|
|
148
|
-
* Retrieve metadata for a specific Machine within an app.
|
|
149
|
-
*
|
|
150
|
-
*/
|
|
151
|
-
export declare const machinesShowMetadata: <ThrowOnError extends boolean = false>(options: Options<MachinesShowMetadataData, ThrowOnError>) => import("./client").RequestResult<MachinesShowMetadataResponses, unknown, ThrowOnError, "fields">;
|
|
152
|
-
/**
|
|
153
|
-
* Patch Metadata (set/remove multiple keys)
|
|
154
|
-
*
|
|
155
|
-
* Update multiple metadata keys at once. Null values and empty strings remove keys.
|
|
156
|
-
*/
|
|
157
|
-
export declare const machinesPatchMetadata: <ThrowOnError extends boolean = false>(options: Options<MachinesPatchMetadataData, ThrowOnError>) => import("./client").RequestResult<MachinesPatchMetadataResponses, MachinesPatchMetadataErrors, ThrowOnError, "fields">;
|
|
158
|
-
/**
|
|
159
|
-
* Delete Metadata
|
|
160
|
-
*
|
|
161
|
-
* Delete metadata for a specific Machine within an app by providing a metadata key.
|
|
162
|
-
*
|
|
163
|
-
*/
|
|
164
|
-
export declare const machinesDeleteMetadata: <ThrowOnError extends boolean = false>(options: Options<MachinesDeleteMetadataData, ThrowOnError>) => import("./client").RequestResult<MachinesDeleteMetadataResponses, unknown, ThrowOnError, "fields">;
|
|
165
|
-
/**
|
|
166
|
-
* Update Metadata
|
|
167
|
-
*
|
|
168
|
-
* Update metadata for a specific machine within an app by providing a metadata key.
|
|
169
|
-
*
|
|
170
|
-
*/
|
|
171
|
-
export declare const machinesUpdateMetadata: <ThrowOnError extends boolean = false>(options: Options<MachinesUpdateMetadataData, ThrowOnError>) => import("./client").RequestResult<MachinesUpdateMetadataResponses, MachinesUpdateMetadataErrors, ThrowOnError, "fields">;
|
|
172
|
-
/**
|
|
173
|
-
* List Processes
|
|
174
|
-
*
|
|
175
|
-
* List all processes running on a specific Machine within an app, with optional sorting parameters.
|
|
176
|
-
*
|
|
177
|
-
*/
|
|
178
|
-
export declare const machinesListProcesses: <ThrowOnError extends boolean = false>(options: Options<MachinesListProcessesData, ThrowOnError>) => import("./client").RequestResult<MachinesListProcessesResponses, MachinesListProcessesErrors, ThrowOnError, "fields">;
|
|
179
|
-
/**
|
|
180
|
-
* Restart Machine
|
|
181
|
-
*
|
|
182
|
-
* Restart a specific Machine within an app, with an optional timeout parameter.
|
|
183
|
-
*
|
|
184
|
-
*/
|
|
185
|
-
export declare const machinesRestart: <ThrowOnError extends boolean = false>(options: Options<MachinesRestartData, ThrowOnError>) => import("./client").RequestResult<MachinesRestartResponses, MachinesRestartErrors, ThrowOnError, "fields">;
|
|
186
|
-
/**
|
|
187
|
-
* Signal Machine
|
|
188
|
-
*
|
|
189
|
-
* Send a signal to a specific Machine within an app using the details provided in the request body.
|
|
190
|
-
*
|
|
191
|
-
*/
|
|
192
|
-
export declare const machinesSignal: <ThrowOnError extends boolean = false>(options: Options<MachinesSignalData, ThrowOnError>) => import("./client").RequestResult<MachinesSignalResponses, MachinesSignalErrors, ThrowOnError, "fields">;
|
|
193
|
-
/**
|
|
194
|
-
* Start Machine
|
|
195
|
-
*
|
|
196
|
-
* Start a specific Machine within an app.
|
|
197
|
-
*
|
|
198
|
-
*/
|
|
199
|
-
export declare const machinesStart: <ThrowOnError extends boolean = false>(options: Options<MachinesStartData, ThrowOnError>) => import("./client").RequestResult<MachinesStartResponses, unknown, ThrowOnError, "fields">;
|
|
200
|
-
/**
|
|
201
|
-
* Stop Machine
|
|
202
|
-
*
|
|
203
|
-
* Stop a specific Machine within an app, with an optional request body to specify signal and timeout.
|
|
204
|
-
*
|
|
205
|
-
*/
|
|
206
|
-
export declare const machinesStop: <ThrowOnError extends boolean = false>(options: Options<MachinesStopData, ThrowOnError>) => import("./client").RequestResult<MachinesStopResponses, MachinesStopErrors, ThrowOnError, "fields">;
|
|
207
|
-
/**
|
|
208
|
-
* Suspend Machine
|
|
209
|
-
*
|
|
210
|
-
* Suspend a specific Machine within an app. The next start operation will attempt (but is not guaranteed) to resume the Machine from a snapshot taken at suspension time, rather than performing a cold boot.
|
|
211
|
-
*
|
|
212
|
-
*/
|
|
213
|
-
export declare const machinesSuspend: <ThrowOnError extends boolean = false>(options: Options<MachinesSuspendData, ThrowOnError>) => import("./client").RequestResult<MachinesSuspendResponses, unknown, ThrowOnError, "fields">;
|
|
214
|
-
/**
|
|
215
|
-
* Uncordon Machine
|
|
216
|
-
*
|
|
217
|
-
* “Cordoning” a Machine refers to disabling its services, so the Fly Proxy won’t route requests to it. In flyctl this is used by blue/green deployments; one set of Machines is started up with services disabled, and when they are all healthy, the services are enabled on the new Machines and disabled on the old ones.
|
|
218
|
-
*
|
|
219
|
-
*/
|
|
220
|
-
export declare const machinesUncordon: <ThrowOnError extends boolean = false>(options: Options<MachinesUncordonData, ThrowOnError>) => import("./client").RequestResult<MachinesUncordonResponses, unknown, ThrowOnError, "fields">;
|
|
221
|
-
/**
|
|
222
|
-
* List Versions
|
|
223
|
-
*
|
|
224
|
-
* List all versions of the configuration for a specific Machine within an app.
|
|
225
|
-
*
|
|
226
|
-
*/
|
|
227
|
-
export declare const machinesListVersions: <ThrowOnError extends boolean = false>(options: Options<MachinesListVersionsData, ThrowOnError>) => import("./client").RequestResult<MachinesListVersionsResponses, unknown, ThrowOnError, "fields">;
|
|
228
|
-
/**
|
|
229
|
-
* Wait for State
|
|
230
|
-
*
|
|
231
|
-
* Wait for a Machine to reach a specific state. Specify the desired state with the state parameter. See the [Machine states table](https://fly.io/docs/machines/working-with-machines/#machine-states) for a list of possible states. The default for this parameter is `started`.
|
|
232
|
-
*
|
|
233
|
-
* This request will block for up to 60 seconds. Set a shorter timeout with the timeout parameter.
|
|
234
|
-
*
|
|
235
|
-
*/
|
|
236
|
-
export declare const machinesWait: <ThrowOnError extends boolean = false>(options: Options<MachinesWaitData, ThrowOnError>) => import("./client").RequestResult<MachinesWaitResponses, MachinesWaitErrors, ThrowOnError, "fields">;
|
|
237
|
-
/**
|
|
238
|
-
* List secret keys belonging to an app
|
|
239
|
-
*/
|
|
240
|
-
export declare const secretkeysList: <ThrowOnError extends boolean = false>(options: Options<SecretkeysListData, ThrowOnError>) => import("./client").RequestResult<SecretkeysListResponses, unknown, ThrowOnError, "fields">;
|
|
241
|
-
/**
|
|
242
|
-
* Delete an app's secret key
|
|
243
|
-
*/
|
|
244
|
-
export declare const secretkeyDelete: <ThrowOnError extends boolean = false>(options: Options<SecretkeyDeleteData, ThrowOnError>) => import("./client").RequestResult<SecretkeyDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
245
|
-
/**
|
|
246
|
-
* Get an app's secret key
|
|
247
|
-
*/
|
|
248
|
-
export declare const secretkeyGet: <ThrowOnError extends boolean = false>(options: Options<SecretkeyGetData, ThrowOnError>) => import("./client").RequestResult<SecretkeyGetResponses, unknown, ThrowOnError, "fields">;
|
|
249
|
-
/**
|
|
250
|
-
* Create or update a secret key
|
|
251
|
-
*/
|
|
252
|
-
export declare const secretkeySet: <ThrowOnError extends boolean = false>(options: Options<SecretkeySetData, ThrowOnError>) => import("./client").RequestResult<SecretkeySetResponses, SecretkeySetErrors, ThrowOnError, "fields">;
|
|
253
|
-
/**
|
|
254
|
-
* Decrypt with a secret key
|
|
255
|
-
*/
|
|
256
|
-
export declare const secretkeyDecrypt: <ThrowOnError extends boolean = false>(options: Options<SecretkeyDecryptData, ThrowOnError>) => import("./client").RequestResult<SecretkeyDecryptResponses, SecretkeyDecryptErrors, ThrowOnError, "fields">;
|
|
257
|
-
/**
|
|
258
|
-
* Encrypt with a secret key
|
|
259
|
-
*/
|
|
260
|
-
export declare const secretkeyEncrypt: <ThrowOnError extends boolean = false>(options: Options<SecretkeyEncryptData, ThrowOnError>) => import("./client").RequestResult<SecretkeyEncryptResponses, SecretkeyEncryptErrors, ThrowOnError, "fields">;
|
|
261
|
-
/**
|
|
262
|
-
* Generate a random secret key
|
|
263
|
-
*/
|
|
264
|
-
export declare const secretkeyGenerate: <ThrowOnError extends boolean = false>(options: Options<SecretkeyGenerateData, ThrowOnError>) => import("./client").RequestResult<SecretkeyGenerateResponses, SecretkeyGenerateErrors, ThrowOnError, "fields">;
|
|
265
|
-
/**
|
|
266
|
-
* Sign with a secret key
|
|
267
|
-
*/
|
|
268
|
-
export declare const secretkeySign: <ThrowOnError extends boolean = false>(options: Options<SecretkeySignData, ThrowOnError>) => import("./client").RequestResult<SecretkeySignResponses, SecretkeySignErrors, ThrowOnError, "fields">;
|
|
269
|
-
/**
|
|
270
|
-
* Verify with a secret key
|
|
271
|
-
*/
|
|
272
|
-
export declare const secretkeyVerify: <ThrowOnError extends boolean = false>(options: Options<SecretkeyVerifyData, ThrowOnError>) => import("./client").RequestResult<SecretkeyVerifyResponses, SecretkeyVerifyErrors, ThrowOnError, "fields">;
|
|
273
|
-
/**
|
|
274
|
-
* List app secrets belonging to an app
|
|
275
|
-
*/
|
|
276
|
-
export declare const secretsList: <ThrowOnError extends boolean = false>(options: Options<SecretsListData, ThrowOnError>) => import("./client").RequestResult<SecretsListResponses, unknown, ThrowOnError, "fields">;
|
|
277
|
-
/**
|
|
278
|
-
* Update app secrets belonging to an app
|
|
279
|
-
*/
|
|
280
|
-
export declare const secretsUpdate: <ThrowOnError extends boolean = false>(options: Options<SecretsUpdateData, ThrowOnError>) => import("./client").RequestResult<SecretsUpdateResponses, SecretsUpdateErrors, ThrowOnError, "fields">;
|
|
281
|
-
/**
|
|
282
|
-
* Delete an app secret
|
|
283
|
-
*/
|
|
284
|
-
export declare const secretDelete: <ThrowOnError extends boolean = false>(options: Options<SecretDeleteData, ThrowOnError>) => import("./client").RequestResult<SecretDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
285
|
-
/**
|
|
286
|
-
* Get an app secret
|
|
287
|
-
*/
|
|
288
|
-
export declare const secretGet: <ThrowOnError extends boolean = false>(options: Options<SecretGetData, ThrowOnError>) => import("./client").RequestResult<SecretGetResponses, unknown, ThrowOnError, "fields">;
|
|
289
|
-
/**
|
|
290
|
-
* Create or update Secret
|
|
291
|
-
*/
|
|
292
|
-
export declare const secretCreate: <ThrowOnError extends boolean = false>(options: Options<SecretCreateData, ThrowOnError>) => import("./client").RequestResult<SecretCreateResponses, SecretCreateErrors, ThrowOnError, "fields">;
|
|
293
|
-
/**
|
|
294
|
-
* List Volumes
|
|
295
|
-
*
|
|
296
|
-
* List all volumes associated with a specific app.
|
|
297
|
-
*
|
|
298
|
-
*/
|
|
299
|
-
export declare const volumesList: <ThrowOnError extends boolean = false>(options: Options<VolumesListData, ThrowOnError>) => import("./client").RequestResult<VolumesListResponses, unknown, ThrowOnError, "fields">;
|
|
300
|
-
/**
|
|
301
|
-
* Create Volume
|
|
302
|
-
*
|
|
303
|
-
* Create a volume for a specific app using the details provided in the request body.
|
|
304
|
-
*
|
|
305
|
-
*/
|
|
306
|
-
export declare const volumesCreate: <ThrowOnError extends boolean = false>(options: Options<VolumesCreateData, ThrowOnError>) => import("./client").RequestResult<VolumesCreateResponses, unknown, ThrowOnError, "fields">;
|
|
307
|
-
/**
|
|
308
|
-
* Destroy Volume
|
|
309
|
-
*
|
|
310
|
-
* Delete a specific volume within an app by volume ID.
|
|
311
|
-
*
|
|
312
|
-
*/
|
|
313
|
-
export declare const volumeDelete: <ThrowOnError extends boolean = false>(options: Options<VolumeDeleteData, ThrowOnError>) => import("./client").RequestResult<VolumeDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
314
|
-
/**
|
|
315
|
-
* Get Volume
|
|
316
|
-
*
|
|
317
|
-
* Retrieve details about a specific volume by its ID within an app.
|
|
318
|
-
*
|
|
319
|
-
*/
|
|
320
|
-
export declare const volumesGetById: <ThrowOnError extends boolean = false>(options: Options<VolumesGetByIdData, ThrowOnError>) => import("./client").RequestResult<VolumesGetByIdResponses, unknown, ThrowOnError, "fields">;
|
|
321
|
-
/**
|
|
322
|
-
* Update Volume
|
|
323
|
-
*
|
|
324
|
-
* Update a volume's configuration using the details provided in the request body.
|
|
325
|
-
*
|
|
326
|
-
*/
|
|
327
|
-
export declare const volumesUpdate: <ThrowOnError extends boolean = false>(options: Options<VolumesUpdateData, ThrowOnError>) => import("./client").RequestResult<VolumesUpdateResponses, VolumesUpdateErrors, ThrowOnError, "fields">;
|
|
328
|
-
/**
|
|
329
|
-
* Extend Volume
|
|
330
|
-
*
|
|
331
|
-
* Extend a volume's size within an app using the details provided in the request body.
|
|
332
|
-
*
|
|
333
|
-
*/
|
|
334
|
-
export declare const volumesExtend: <ThrowOnError extends boolean = false>(options: Options<VolumesExtendData, ThrowOnError>) => import("./client").RequestResult<VolumesExtendResponses, unknown, ThrowOnError, "fields">;
|
|
335
|
-
/**
|
|
336
|
-
* List Snapshots
|
|
337
|
-
*
|
|
338
|
-
* List all snapshots for a specific volume within an app.
|
|
339
|
-
*
|
|
340
|
-
*/
|
|
341
|
-
export declare const volumesListSnapshots: <ThrowOnError extends boolean = false>(options: Options<VolumesListSnapshotsData, ThrowOnError>) => import("./client").RequestResult<VolumesListSnapshotsResponses, unknown, ThrowOnError, "fields">;
|
|
342
|
-
/**
|
|
343
|
-
* Create Snapshot
|
|
344
|
-
*
|
|
345
|
-
* Create a snapshot for a specific volume within an app.
|
|
346
|
-
*
|
|
347
|
-
*/
|
|
348
|
-
export declare const createVolumeSnapshot: <ThrowOnError extends boolean = false>(options: Options<CreateVolumeSnapshotData, ThrowOnError>) => import("./client").RequestResult<CreateVolumeSnapshotResponses, unknown, ThrowOnError, "fields">;
|
|
349
|
-
/**
|
|
350
|
-
* Get Placements
|
|
351
|
-
*
|
|
352
|
-
* Simulates placing the specified number of machines into regions, depending on available capacity and limits.
|
|
353
|
-
*/
|
|
354
|
-
export declare const platformPlacementsPost: <ThrowOnError extends boolean = false>(options: Options<PlatformPlacementsPostData, ThrowOnError>) => import("./client").RequestResult<PlatformPlacementsPostResponses, unknown, ThrowOnError, "fields">;
|
|
355
|
-
/**
|
|
356
|
-
* Get Regions
|
|
357
|
-
*
|
|
358
|
-
* List all regions on the platform with their current Machine capacity.
|
|
359
|
-
*/
|
|
360
|
-
export declare const platformRegionsGet: <ThrowOnError extends boolean = false>(options?: Options<PlatformRegionsGetData, ThrowOnError>) => import("./client").RequestResult<PlatformRegionsGetResponses, unknown, ThrowOnError, "fields">;
|
|
361
|
-
/**
|
|
362
|
-
* Request a Petsem token for accessing KMS
|
|
363
|
-
*
|
|
364
|
-
* This site hosts documentation generated from the Fly.io Machines API OpenAPI specification. Visit our complete [Machines API docs](https://fly.io/docs/machines/api/apps-resource/) for details about using the Apps resource.
|
|
365
|
-
*/
|
|
366
|
-
export declare const tokensRequestKms: <ThrowOnError extends boolean = false>(options?: Options<TokensRequestKmsData, ThrowOnError>) => import("./client").RequestResult<TokensRequestKmsResponses, unknown, ThrowOnError, "fields">;
|
|
367
|
-
/**
|
|
368
|
-
* Request an OIDC token
|
|
369
|
-
*
|
|
370
|
-
* Request an Open ID Connect token for your machine. Customize the audience claim with the `aud` parameter. This returns a JWT token. Learn more about [using OpenID Connect](/docs/reference/openid-connect/) on Fly.io.
|
|
371
|
-
*
|
|
372
|
-
*/
|
|
373
|
-
export declare const tokensRequestOidc: <ThrowOnError extends boolean = false>(options: Options<TokensRequestOidcData, ThrowOnError>) => import("./client").RequestResult<TokensRequestOidcResponses, TokensRequestOidcErrors, ThrowOnError, "fields">;
|
|
374
|
-
/**
|
|
375
|
-
* Get Current Token Information
|
|
376
|
-
*
|
|
377
|
-
* Get information about the current macaroon token(s), including organizations, apps, and whether each token is from a user or machine
|
|
378
|
-
*/
|
|
379
|
-
export declare const currentTokenShow: <ThrowOnError extends boolean = false>(options?: Options<CurrentTokenShowData, ThrowOnError>) => import("./client").RequestResult<CurrentTokenShowResponses, CurrentTokenShowErrors, ThrowOnError, "fields">;
|