@runpod/typescript-api-sdk 0.6.0 → 0.7.0
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/dist/index.d.cts +586 -1
- package/dist/index.d.ts +586 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -408,6 +408,72 @@ interface paths {
|
|
|
408
408
|
patch: operations["updateSecret"];
|
|
409
409
|
trace?: never;
|
|
410
410
|
};
|
|
411
|
+
"/v2/signup/authentication-attempts": {
|
|
412
|
+
parameters: {
|
|
413
|
+
query?: never;
|
|
414
|
+
header?: never;
|
|
415
|
+
path?: never;
|
|
416
|
+
cookie?: never;
|
|
417
|
+
};
|
|
418
|
+
get?: never;
|
|
419
|
+
put?: never;
|
|
420
|
+
/**
|
|
421
|
+
* Start an authentication attempt
|
|
422
|
+
* @description Emails a verification code to sign in to an existing account or create a new one, without an API key. The response is the same whether or not an account exists for the email.
|
|
423
|
+
*/
|
|
424
|
+
post: operations["createAuthenticationAttempt"];
|
|
425
|
+
delete?: never;
|
|
426
|
+
options?: never;
|
|
427
|
+
head?: never;
|
|
428
|
+
patch?: never;
|
|
429
|
+
trace?: never;
|
|
430
|
+
};
|
|
431
|
+
"/v2/signup/authentication-attempts/{id}/verify": {
|
|
432
|
+
parameters: {
|
|
433
|
+
query?: never;
|
|
434
|
+
header?: never;
|
|
435
|
+
path: {
|
|
436
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
437
|
+
id: string;
|
|
438
|
+
};
|
|
439
|
+
cookie?: never;
|
|
440
|
+
};
|
|
441
|
+
get?: never;
|
|
442
|
+
put?: never;
|
|
443
|
+
/**
|
|
444
|
+
* Verify an authentication attempt
|
|
445
|
+
* @description Exchanges the emailed code and the `codeVerifier` whose hash started the attempt for a new API key, visible and revocable in the console. A wrong code is a `422`, and five wrong codes lock the attempt.
|
|
446
|
+
*/
|
|
447
|
+
post: operations["verifyAuthenticationAttempt"];
|
|
448
|
+
delete?: never;
|
|
449
|
+
options?: never;
|
|
450
|
+
head?: never;
|
|
451
|
+
patch?: never;
|
|
452
|
+
trace?: never;
|
|
453
|
+
};
|
|
454
|
+
"/v2/signup/authentication-attempts/{id}/resend": {
|
|
455
|
+
parameters: {
|
|
456
|
+
query?: never;
|
|
457
|
+
header?: never;
|
|
458
|
+
path: {
|
|
459
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
460
|
+
id: string;
|
|
461
|
+
};
|
|
462
|
+
cookie?: never;
|
|
463
|
+
};
|
|
464
|
+
get?: never;
|
|
465
|
+
put?: never;
|
|
466
|
+
/**
|
|
467
|
+
* Resend an authentication attempt's code
|
|
468
|
+
* @description Emails a new verification code and invalidates the previous one. The attempt's `expiresAt` and wrong-code count carry over. Resending before `resendAfter` is a `429` with `Retry-After`.
|
|
469
|
+
*/
|
|
470
|
+
post: operations["resendAuthenticationAttempt"];
|
|
471
|
+
delete?: never;
|
|
472
|
+
options?: never;
|
|
473
|
+
head?: never;
|
|
474
|
+
patch?: never;
|
|
475
|
+
trace?: never;
|
|
476
|
+
};
|
|
411
477
|
"/v2/pods": {
|
|
412
478
|
parameters: {
|
|
413
479
|
query?: never;
|
|
@@ -643,6 +709,55 @@ interface paths {
|
|
|
643
709
|
patch?: never;
|
|
644
710
|
trace?: never;
|
|
645
711
|
};
|
|
712
|
+
"/v2/pods/{id}/exec": {
|
|
713
|
+
parameters: {
|
|
714
|
+
query?: never;
|
|
715
|
+
header?: never;
|
|
716
|
+
path: {
|
|
717
|
+
/**
|
|
718
|
+
* @description Pod identifier
|
|
719
|
+
* @example pod_abc123
|
|
720
|
+
*/
|
|
721
|
+
id: string;
|
|
722
|
+
};
|
|
723
|
+
cookie?: never;
|
|
724
|
+
};
|
|
725
|
+
get?: never;
|
|
726
|
+
put?: never;
|
|
727
|
+
/**
|
|
728
|
+
* Run a command in a pod
|
|
729
|
+
* @description Runs one command inside the pod's container and returns its stdout,
|
|
730
|
+
* stderr and exit code once it finishes. No SSH key, public IP or exposed
|
|
731
|
+
* port is needed, and it works with any image.
|
|
732
|
+
*
|
|
733
|
+
* `command` is an argv array, run directly and never through a shell. For
|
|
734
|
+
* pipes, redirects or globbing pass `["sh", "-c", "..."]`.
|
|
735
|
+
*
|
|
736
|
+
* A command that exits non-zero is a result, not an error: the call
|
|
737
|
+
* answers `200` with `exitCode` set. A command still running after
|
|
738
|
+
* `timeoutSeconds` (1-25, default 20) answers `200` with
|
|
739
|
+
* `timedOut: true` and a null `exitCode`. `timedOut` means the call
|
|
740
|
+
* stopped waiting, not that the command was stopped: it may keep
|
|
741
|
+
* running in the container.
|
|
742
|
+
*
|
|
743
|
+
* `stdout` and `stderr` are each capped at 1 MiB. Output past the cap is
|
|
744
|
+
* cut and `truncated` is `true`.
|
|
745
|
+
*
|
|
746
|
+
* The pod must be running with its container up, otherwise this answers
|
|
747
|
+
* `409`; while the container is still starting, the `409` carries
|
|
748
|
+
* `Retry-After`. A pod whose machine has not been updated for exec yet
|
|
749
|
+
* answers `503` with `Retry-After`.
|
|
750
|
+
*
|
|
751
|
+
* `X-Team-Id` is not applied on this route: it reaches only pods owned by
|
|
752
|
+
* the caller's own account.
|
|
753
|
+
*/
|
|
754
|
+
post: operations["execPod"];
|
|
755
|
+
delete?: never;
|
|
756
|
+
options?: never;
|
|
757
|
+
head?: never;
|
|
758
|
+
patch?: never;
|
|
759
|
+
trace?: never;
|
|
760
|
+
};
|
|
646
761
|
"/v2/clusters": {
|
|
647
762
|
parameters: {
|
|
648
763
|
query?: never;
|
|
@@ -3589,6 +3704,75 @@ interface components {
|
|
|
3589
3704
|
*/
|
|
3590
3705
|
keys: string[];
|
|
3591
3706
|
};
|
|
3707
|
+
CreateAuthenticationAttemptRequest: {
|
|
3708
|
+
/**
|
|
3709
|
+
* Format: email
|
|
3710
|
+
* @description Address to send the verification code to. It may belong to an existing account or a new one.
|
|
3711
|
+
* @example owner@example.com
|
|
3712
|
+
*/
|
|
3713
|
+
email: string;
|
|
3714
|
+
/**
|
|
3715
|
+
* @description Name of the API key issued when verification succeeds.
|
|
3716
|
+
* @example laptop-cli
|
|
3717
|
+
*/
|
|
3718
|
+
keyName: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* @description Unpadded base64url SHA-256 hash of a random `codeVerifier` the caller keeps private. Verify and resend require the matching verifier.
|
|
3721
|
+
* @example E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
|
|
3722
|
+
*/
|
|
3723
|
+
codeChallenge: string;
|
|
3724
|
+
};
|
|
3725
|
+
VerifyAuthenticationAttemptRequest: {
|
|
3726
|
+
/**
|
|
3727
|
+
* @description Verification code from the email.
|
|
3728
|
+
* @example 123456
|
|
3729
|
+
*/
|
|
3730
|
+
code: string;
|
|
3731
|
+
codeVerifier: components["schemas"]["CodeVerifier"];
|
|
3732
|
+
};
|
|
3733
|
+
ResendAuthenticationAttemptRequest: {
|
|
3734
|
+
codeVerifier: components["schemas"]["CodeVerifier"];
|
|
3735
|
+
};
|
|
3736
|
+
/**
|
|
3737
|
+
* @description The random secret whose SHA-256 hash was sent as `codeChallenge`.
|
|
3738
|
+
* @example dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
|
|
3739
|
+
*/
|
|
3740
|
+
CodeVerifier: string;
|
|
3741
|
+
AuthenticationAttempt: {
|
|
3742
|
+
/**
|
|
3743
|
+
* @description Identifies the attempt in verify and resend.
|
|
3744
|
+
* @example att_3kq9x81mzp
|
|
3745
|
+
*/
|
|
3746
|
+
attemptId: string;
|
|
3747
|
+
/**
|
|
3748
|
+
* Format: date-time
|
|
3749
|
+
* @description When the attempt stops accepting codes. Resending does not extend it.
|
|
3750
|
+
* @example 2026-10-16T18:10:00Z
|
|
3751
|
+
*/
|
|
3752
|
+
expiresAt: string;
|
|
3753
|
+
/**
|
|
3754
|
+
* Format: date-time
|
|
3755
|
+
* @description Earliest time a resend is accepted.
|
|
3756
|
+
* @example 2026-10-16T18:00:30Z
|
|
3757
|
+
*/
|
|
3758
|
+
resendAfter: string;
|
|
3759
|
+
};
|
|
3760
|
+
AuthenticationAttemptResult: {
|
|
3761
|
+
/** @example user_2abc9xyz */
|
|
3762
|
+
userId: string;
|
|
3763
|
+
credential: {
|
|
3764
|
+
/**
|
|
3765
|
+
* @description Identifies the key in the console, where it can be revoked.
|
|
3766
|
+
* @example key_7Rk2m0pq
|
|
3767
|
+
*/
|
|
3768
|
+
id: string;
|
|
3769
|
+
/**
|
|
3770
|
+
* @description The raw API key. It is returned once, so store it before doing anything else.
|
|
3771
|
+
* @example rpa_EXAMPLEONLYEXAMPLEONLYEXAMPLEONLY
|
|
3772
|
+
*/
|
|
3773
|
+
apiKey: string;
|
|
3774
|
+
};
|
|
3775
|
+
};
|
|
3592
3776
|
/** @description An account-scoped secret: an encrypted string stored by Runpod, referenced from pod, serverless, and template environment variables with the `{{ RUNPOD_SECRET_<name> }}` placeholder, substituted with the secret's value when the pod or worker boots. The value is write-only and never returned by the API. */
|
|
3593
3777
|
Secret: {
|
|
3594
3778
|
/**
|
|
@@ -3791,7 +3975,7 @@ interface components {
|
|
|
3791
3975
|
* access: injects a `PUBLIC_KEY` environment variable carrying
|
|
3792
3976
|
* your account's registered SSH public keys, unless the request
|
|
3793
3977
|
* already sets one. **Requires registered keys** (`PUT
|
|
3794
|
-
* /v2/account/ssh-keys`)
|
|
3978
|
+
* /v2/account/ssh-keys`); with none registered the flag does
|
|
3795
3979
|
* nothing and the pod has no SSH access. Only images that honor
|
|
3796
3980
|
* the convention start sshd from it (all Runpod official images
|
|
3797
3981
|
* do). Connect using the pod's `ssh` block; the `ssh.direct`
|
|
@@ -3849,6 +4033,75 @@ interface components {
|
|
|
3849
4033
|
PodActionRequest: {
|
|
3850
4034
|
action: components["schemas"]["PodAction"];
|
|
3851
4035
|
};
|
|
4036
|
+
PodExecRequest: {
|
|
4037
|
+
/**
|
|
4038
|
+
* @description Command to run, as an argv array of 1-256 arguments of at most 4096
|
|
4039
|
+
* characters each. It is run directly, never through a shell; for
|
|
4040
|
+
* pipes, redirects or globbing pass `["sh", "-c", "..."]`. The first
|
|
4041
|
+
* element, the program, must contain a non-whitespace character;
|
|
4042
|
+
* later arguments may be empty. No argument may contain a NUL
|
|
4043
|
+
* character.
|
|
4044
|
+
* @example [
|
|
4045
|
+
* "nvidia-smi",
|
|
4046
|
+
* "--query-gpu=name,memory.used",
|
|
4047
|
+
* "--format=csv"
|
|
4048
|
+
* ]
|
|
4049
|
+
*/
|
|
4050
|
+
command: [
|
|
4051
|
+
string
|
|
4052
|
+
];
|
|
4053
|
+
/**
|
|
4054
|
+
* @description How long the call waits for the command to finish, in seconds. A
|
|
4055
|
+
* command still running at this point returns with `timedOut: true`.
|
|
4056
|
+
* @default 20
|
|
4057
|
+
* @example 10
|
|
4058
|
+
*/
|
|
4059
|
+
timeoutSeconds?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* @description Absolute working directory for the command, at most 1024 characters
|
|
4062
|
+
* and without control characters. Defaults to the image's `WORKDIR`.
|
|
4063
|
+
* @example /workspace
|
|
4064
|
+
*/
|
|
4065
|
+
cwd?: string;
|
|
4066
|
+
/**
|
|
4067
|
+
* @description Up to 64 environment variables added to the container's environment
|
|
4068
|
+
* for this command only. A name is 1-256 characters and must not
|
|
4069
|
+
* contain `=` or a NUL character; a value is at most 16384 characters
|
|
4070
|
+
* and must not contain a NUL character.
|
|
4071
|
+
* @example {
|
|
4072
|
+
* "HF_HOME": "/workspace/hf"
|
|
4073
|
+
* }
|
|
4074
|
+
*/
|
|
4075
|
+
env?: {
|
|
4076
|
+
[key: string]: string;
|
|
4077
|
+
};
|
|
4078
|
+
};
|
|
4079
|
+
PodExecResult: {
|
|
4080
|
+
/**
|
|
4081
|
+
* @description The command's standard output, as UTF-8 with invalid bytes
|
|
4082
|
+
* replaced. Capped at 1 MiB; see `truncated`.
|
|
4083
|
+
*/
|
|
4084
|
+
stdout: string;
|
|
4085
|
+
/**
|
|
4086
|
+
* @description The command's standard error, as UTF-8 with invalid bytes
|
|
4087
|
+
* replaced. Capped at 1 MiB; see `truncated`.
|
|
4088
|
+
*/
|
|
4089
|
+
stderr: string;
|
|
4090
|
+
/**
|
|
4091
|
+
* @description The command's exit code. A non-zero code is a result, not an error.
|
|
4092
|
+
* Null only when `timedOut` is `true`.
|
|
4093
|
+
*/
|
|
4094
|
+
exitCode: number | null;
|
|
4095
|
+
/**
|
|
4096
|
+
* @description The call stopped waiting at `timeoutSeconds`. It does not mean the
|
|
4097
|
+
* command was stopped: it may still be running inside the container.
|
|
4098
|
+
*/
|
|
4099
|
+
timedOut: boolean;
|
|
4100
|
+
/** @description `stdout` or `stderr` reached the 1 MiB cap and was cut. */
|
|
4101
|
+
truncated: boolean;
|
|
4102
|
+
/** @description Wall time of the command as measured on the pod's machine, in milliseconds. */
|
|
4103
|
+
durationMs: number;
|
|
4104
|
+
};
|
|
3852
4105
|
/** @description A bare list of pods. `GET /v2/clusters/{id}/pods` returns it as-is (a cluster's members are a small, complete set); `GET /v2/pods` composes it with the pagination block via ListPodsResponse. */
|
|
3853
4106
|
PodList: {
|
|
3854
4107
|
pods: components["schemas"]["Pod"][];
|
|
@@ -6913,6 +7166,205 @@ interface operations {
|
|
|
6913
7166
|
};
|
|
6914
7167
|
};
|
|
6915
7168
|
};
|
|
7169
|
+
createAuthenticationAttempt: {
|
|
7170
|
+
parameters: {
|
|
7171
|
+
query?: never;
|
|
7172
|
+
header: {
|
|
7173
|
+
/**
|
|
7174
|
+
* @description Use an unpredictable unique key, such as a UUID, for each new attempt. Retrying with the same key and body returns the same attempt without sending another email. For the same email, the same key with a different body is a `422`.
|
|
7175
|
+
* @example 0f8c2d4e-6a1b-4c3d-9e7f-1a2b3c4d5e6f
|
|
7176
|
+
*/
|
|
7177
|
+
"Idempotency-Key": string;
|
|
7178
|
+
};
|
|
7179
|
+
path?: never;
|
|
7180
|
+
cookie?: never;
|
|
7181
|
+
};
|
|
7182
|
+
requestBody: {
|
|
7183
|
+
content: {
|
|
7184
|
+
"application/json": components["schemas"]["CreateAuthenticationAttemptRequest"];
|
|
7185
|
+
};
|
|
7186
|
+
};
|
|
7187
|
+
responses: {
|
|
7188
|
+
/** @description Created. A verification code was emailed. */
|
|
7189
|
+
201: {
|
|
7190
|
+
headers: {
|
|
7191
|
+
[name: string]: unknown;
|
|
7192
|
+
};
|
|
7193
|
+
content: {
|
|
7194
|
+
"application/json": components["schemas"]["AuthenticationAttempt"];
|
|
7195
|
+
};
|
|
7196
|
+
};
|
|
7197
|
+
/** @description The request is malformed or its body could not be read. */
|
|
7198
|
+
400: {
|
|
7199
|
+
headers: {
|
|
7200
|
+
[name: string]: unknown;
|
|
7201
|
+
};
|
|
7202
|
+
content: {
|
|
7203
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7204
|
+
};
|
|
7205
|
+
};
|
|
7206
|
+
/** @description The incoming request body exceeds 4096 bytes (4 KiB). */
|
|
7207
|
+
413: {
|
|
7208
|
+
headers: {
|
|
7209
|
+
[name: string]: unknown;
|
|
7210
|
+
};
|
|
7211
|
+
content: {
|
|
7212
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7213
|
+
};
|
|
7214
|
+
};
|
|
7215
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7216
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7217
|
+
/** @description Error */
|
|
7218
|
+
default: {
|
|
7219
|
+
headers: {
|
|
7220
|
+
[name: string]: unknown;
|
|
7221
|
+
};
|
|
7222
|
+
content: {
|
|
7223
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7224
|
+
};
|
|
7225
|
+
};
|
|
7226
|
+
};
|
|
7227
|
+
};
|
|
7228
|
+
verifyAuthenticationAttempt: {
|
|
7229
|
+
parameters: {
|
|
7230
|
+
query?: never;
|
|
7231
|
+
header?: never;
|
|
7232
|
+
path: {
|
|
7233
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
7234
|
+
id: string;
|
|
7235
|
+
};
|
|
7236
|
+
cookie?: never;
|
|
7237
|
+
};
|
|
7238
|
+
requestBody: {
|
|
7239
|
+
content: {
|
|
7240
|
+
"application/json": components["schemas"]["VerifyAuthenticationAttemptRequest"];
|
|
7241
|
+
};
|
|
7242
|
+
};
|
|
7243
|
+
responses: {
|
|
7244
|
+
/** @description OK. The attempt is consumed and the key is issued. */
|
|
7245
|
+
200: {
|
|
7246
|
+
headers: {
|
|
7247
|
+
"Cache-Control": "no-store";
|
|
7248
|
+
[name: string]: unknown;
|
|
7249
|
+
};
|
|
7250
|
+
content: {
|
|
7251
|
+
"application/json": components["schemas"]["AuthenticationAttemptResult"];
|
|
7252
|
+
};
|
|
7253
|
+
};
|
|
7254
|
+
/** @description The request is malformed or its body could not be read. */
|
|
7255
|
+
400: {
|
|
7256
|
+
headers: {
|
|
7257
|
+
[name: string]: unknown;
|
|
7258
|
+
};
|
|
7259
|
+
content: {
|
|
7260
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7261
|
+
};
|
|
7262
|
+
};
|
|
7263
|
+
/** @description The account requires SSO or MFA, or belongs to an organization. Sign in through the console instead. */
|
|
7264
|
+
403: {
|
|
7265
|
+
headers: {
|
|
7266
|
+
[name: string]: unknown;
|
|
7267
|
+
};
|
|
7268
|
+
content: {
|
|
7269
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7270
|
+
};
|
|
7271
|
+
};
|
|
7272
|
+
/** @description No usable attempt matches this id and `codeVerifier`. It does not exist, expired, already issued a key, or locked after five wrong codes. */
|
|
7273
|
+
404: {
|
|
7274
|
+
headers: {
|
|
7275
|
+
[name: string]: unknown;
|
|
7276
|
+
};
|
|
7277
|
+
content: {
|
|
7278
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7279
|
+
};
|
|
7280
|
+
};
|
|
7281
|
+
/** @description The incoming request body exceeds 4096 bytes (4 KiB). */
|
|
7282
|
+
413: {
|
|
7283
|
+
headers: {
|
|
7284
|
+
[name: string]: unknown;
|
|
7285
|
+
};
|
|
7286
|
+
content: {
|
|
7287
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7288
|
+
};
|
|
7289
|
+
};
|
|
7290
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7291
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7292
|
+
/** @description Error */
|
|
7293
|
+
default: {
|
|
7294
|
+
headers: {
|
|
7295
|
+
[name: string]: unknown;
|
|
7296
|
+
};
|
|
7297
|
+
content: {
|
|
7298
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7299
|
+
};
|
|
7300
|
+
};
|
|
7301
|
+
};
|
|
7302
|
+
};
|
|
7303
|
+
resendAuthenticationAttempt: {
|
|
7304
|
+
parameters: {
|
|
7305
|
+
query?: never;
|
|
7306
|
+
header?: never;
|
|
7307
|
+
path: {
|
|
7308
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
7309
|
+
id: string;
|
|
7310
|
+
};
|
|
7311
|
+
cookie?: never;
|
|
7312
|
+
};
|
|
7313
|
+
requestBody: {
|
|
7314
|
+
content: {
|
|
7315
|
+
"application/json": components["schemas"]["ResendAuthenticationAttemptRequest"];
|
|
7316
|
+
};
|
|
7317
|
+
};
|
|
7318
|
+
responses: {
|
|
7319
|
+
/** @description OK. A new code was emailed. */
|
|
7320
|
+
200: {
|
|
7321
|
+
headers: {
|
|
7322
|
+
[name: string]: unknown;
|
|
7323
|
+
};
|
|
7324
|
+
content: {
|
|
7325
|
+
"application/json": components["schemas"]["AuthenticationAttempt"];
|
|
7326
|
+
};
|
|
7327
|
+
};
|
|
7328
|
+
/** @description The request is malformed or its body could not be read. */
|
|
7329
|
+
400: {
|
|
7330
|
+
headers: {
|
|
7331
|
+
[name: string]: unknown;
|
|
7332
|
+
};
|
|
7333
|
+
content: {
|
|
7334
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7335
|
+
};
|
|
7336
|
+
};
|
|
7337
|
+
/** @description No usable attempt matches this id and `codeVerifier`. It does not exist, expired, already issued a key, or locked after five wrong codes. */
|
|
7338
|
+
404: {
|
|
7339
|
+
headers: {
|
|
7340
|
+
[name: string]: unknown;
|
|
7341
|
+
};
|
|
7342
|
+
content: {
|
|
7343
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7344
|
+
};
|
|
7345
|
+
};
|
|
7346
|
+
/** @description The incoming request body exceeds 4096 bytes (4 KiB). */
|
|
7347
|
+
413: {
|
|
7348
|
+
headers: {
|
|
7349
|
+
[name: string]: unknown;
|
|
7350
|
+
};
|
|
7351
|
+
content: {
|
|
7352
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7353
|
+
};
|
|
7354
|
+
};
|
|
7355
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7356
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7357
|
+
/** @description Error */
|
|
7358
|
+
default: {
|
|
7359
|
+
headers: {
|
|
7360
|
+
[name: string]: unknown;
|
|
7361
|
+
};
|
|
7362
|
+
content: {
|
|
7363
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7364
|
+
};
|
|
7365
|
+
};
|
|
7366
|
+
};
|
|
7367
|
+
};
|
|
6916
7368
|
listPods: {
|
|
6917
7369
|
parameters: {
|
|
6918
7370
|
query?: {
|
|
@@ -7312,6 +7764,128 @@ interface operations {
|
|
|
7312
7764
|
};
|
|
7313
7765
|
};
|
|
7314
7766
|
};
|
|
7767
|
+
execPod: {
|
|
7768
|
+
parameters: {
|
|
7769
|
+
query?: never;
|
|
7770
|
+
header?: never;
|
|
7771
|
+
path: {
|
|
7772
|
+
/**
|
|
7773
|
+
* @description Pod identifier
|
|
7774
|
+
* @example pod_abc123
|
|
7775
|
+
*/
|
|
7776
|
+
id: string;
|
|
7777
|
+
};
|
|
7778
|
+
cookie?: never;
|
|
7779
|
+
};
|
|
7780
|
+
requestBody: {
|
|
7781
|
+
content: {
|
|
7782
|
+
"application/json": components["schemas"]["PodExecRequest"];
|
|
7783
|
+
};
|
|
7784
|
+
};
|
|
7785
|
+
responses: {
|
|
7786
|
+
/** @description The command finished or the call stopped waiting for it. A non-zero `exitCode` is a result, not an error. */
|
|
7787
|
+
200: {
|
|
7788
|
+
headers: {
|
|
7789
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7790
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7791
|
+
[name: string]: unknown;
|
|
7792
|
+
};
|
|
7793
|
+
content: {
|
|
7794
|
+
"application/json": components["schemas"]["PodExecResult"];
|
|
7795
|
+
};
|
|
7796
|
+
};
|
|
7797
|
+
400: components["responses"]["BadRequestError"];
|
|
7798
|
+
401: components["responses"]["UnauthorizedError"];
|
|
7799
|
+
403: components["responses"]["ForbiddenError"];
|
|
7800
|
+
404: components["responses"]["NotFoundError"];
|
|
7801
|
+
/**
|
|
7802
|
+
* @description The pod is not running, or its container has not started yet. A
|
|
7803
|
+
* container that is starting answers with `Retry-After`.
|
|
7804
|
+
*/
|
|
7805
|
+
409: {
|
|
7806
|
+
headers: {
|
|
7807
|
+
/**
|
|
7808
|
+
* @description Seconds to wait before retrying. Sent only while the pod's container is starting.
|
|
7809
|
+
* @example 5
|
|
7810
|
+
*/
|
|
7811
|
+
"Retry-After"?: number;
|
|
7812
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7813
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7814
|
+
[name: string]: unknown;
|
|
7815
|
+
};
|
|
7816
|
+
content: {
|
|
7817
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7818
|
+
};
|
|
7819
|
+
};
|
|
7820
|
+
413: components["responses"]["RequestTooLargeError"];
|
|
7821
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7822
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7823
|
+
/**
|
|
7824
|
+
* @description The call did not complete. When the pod could not be looked up, or
|
|
7825
|
+
* its machine or the exec service could not be reached, the command
|
|
7826
|
+
* did not start: retry the call. When the command was sent but no
|
|
7827
|
+
* usable answer came back, it may still be running: check before you
|
|
7828
|
+
* retry. When the result could not be read, the command ran.
|
|
7829
|
+
*/
|
|
7830
|
+
502: {
|
|
7831
|
+
headers: {
|
|
7832
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7833
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7834
|
+
[name: string]: unknown;
|
|
7835
|
+
};
|
|
7836
|
+
content: {
|
|
7837
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7838
|
+
};
|
|
7839
|
+
};
|
|
7840
|
+
/**
|
|
7841
|
+
* @description Command execution is not available for this pod right now: its
|
|
7842
|
+
* machine has not been updated for exec, execution is busy, or it is
|
|
7843
|
+
* temporarily unavailable. The pod itself is unaffected; retry after
|
|
7844
|
+
* `Retry-After`.
|
|
7845
|
+
*/
|
|
7846
|
+
503: {
|
|
7847
|
+
headers: {
|
|
7848
|
+
/**
|
|
7849
|
+
* @description Seconds to wait before retrying.
|
|
7850
|
+
* @example 30
|
|
7851
|
+
*/
|
|
7852
|
+
"Retry-After"?: number;
|
|
7853
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7854
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7855
|
+
[name: string]: unknown;
|
|
7856
|
+
};
|
|
7857
|
+
content: {
|
|
7858
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7859
|
+
};
|
|
7860
|
+
};
|
|
7861
|
+
/**
|
|
7862
|
+
* @description The pod's machine, or the exec service in front of it, did not
|
|
7863
|
+
* answer in time. The command may still be running: check before you
|
|
7864
|
+
* retry.
|
|
7865
|
+
*/
|
|
7866
|
+
504: {
|
|
7867
|
+
headers: {
|
|
7868
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7869
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7870
|
+
[name: string]: unknown;
|
|
7871
|
+
};
|
|
7872
|
+
content: {
|
|
7873
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7874
|
+
};
|
|
7875
|
+
};
|
|
7876
|
+
/** @description Error */
|
|
7877
|
+
default: {
|
|
7878
|
+
headers: {
|
|
7879
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7880
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7881
|
+
[name: string]: unknown;
|
|
7882
|
+
};
|
|
7883
|
+
content: {
|
|
7884
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7885
|
+
};
|
|
7886
|
+
};
|
|
7887
|
+
};
|
|
7888
|
+
};
|
|
7315
7889
|
listClusters: {
|
|
7316
7890
|
parameters: {
|
|
7317
7891
|
query?: {
|
|
@@ -8690,6 +9264,17 @@ interface operations {
|
|
|
8690
9264
|
401: components["responses"]["UnauthorizedError"];
|
|
8691
9265
|
403: components["responses"]["ForbiddenError"];
|
|
8692
9266
|
404: components["responses"]["NotFoundError"];
|
|
9267
|
+
/** @description The volume was created less than five minutes ago. Retry after the time given in the detail. */
|
|
9268
|
+
409: {
|
|
9269
|
+
headers: {
|
|
9270
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
9271
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
9272
|
+
[name: string]: unknown;
|
|
9273
|
+
};
|
|
9274
|
+
content: {
|
|
9275
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
9276
|
+
};
|
|
9277
|
+
};
|
|
8693
9278
|
429: components["responses"]["TooManyRequestsError"];
|
|
8694
9279
|
/** @description Error */
|
|
8695
9280
|
default: {
|
package/dist/index.d.ts
CHANGED
|
@@ -408,6 +408,72 @@ interface paths {
|
|
|
408
408
|
patch: operations["updateSecret"];
|
|
409
409
|
trace?: never;
|
|
410
410
|
};
|
|
411
|
+
"/v2/signup/authentication-attempts": {
|
|
412
|
+
parameters: {
|
|
413
|
+
query?: never;
|
|
414
|
+
header?: never;
|
|
415
|
+
path?: never;
|
|
416
|
+
cookie?: never;
|
|
417
|
+
};
|
|
418
|
+
get?: never;
|
|
419
|
+
put?: never;
|
|
420
|
+
/**
|
|
421
|
+
* Start an authentication attempt
|
|
422
|
+
* @description Emails a verification code to sign in to an existing account or create a new one, without an API key. The response is the same whether or not an account exists for the email.
|
|
423
|
+
*/
|
|
424
|
+
post: operations["createAuthenticationAttempt"];
|
|
425
|
+
delete?: never;
|
|
426
|
+
options?: never;
|
|
427
|
+
head?: never;
|
|
428
|
+
patch?: never;
|
|
429
|
+
trace?: never;
|
|
430
|
+
};
|
|
431
|
+
"/v2/signup/authentication-attempts/{id}/verify": {
|
|
432
|
+
parameters: {
|
|
433
|
+
query?: never;
|
|
434
|
+
header?: never;
|
|
435
|
+
path: {
|
|
436
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
437
|
+
id: string;
|
|
438
|
+
};
|
|
439
|
+
cookie?: never;
|
|
440
|
+
};
|
|
441
|
+
get?: never;
|
|
442
|
+
put?: never;
|
|
443
|
+
/**
|
|
444
|
+
* Verify an authentication attempt
|
|
445
|
+
* @description Exchanges the emailed code and the `codeVerifier` whose hash started the attempt for a new API key, visible and revocable in the console. A wrong code is a `422`, and five wrong codes lock the attempt.
|
|
446
|
+
*/
|
|
447
|
+
post: operations["verifyAuthenticationAttempt"];
|
|
448
|
+
delete?: never;
|
|
449
|
+
options?: never;
|
|
450
|
+
head?: never;
|
|
451
|
+
patch?: never;
|
|
452
|
+
trace?: never;
|
|
453
|
+
};
|
|
454
|
+
"/v2/signup/authentication-attempts/{id}/resend": {
|
|
455
|
+
parameters: {
|
|
456
|
+
query?: never;
|
|
457
|
+
header?: never;
|
|
458
|
+
path: {
|
|
459
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
460
|
+
id: string;
|
|
461
|
+
};
|
|
462
|
+
cookie?: never;
|
|
463
|
+
};
|
|
464
|
+
get?: never;
|
|
465
|
+
put?: never;
|
|
466
|
+
/**
|
|
467
|
+
* Resend an authentication attempt's code
|
|
468
|
+
* @description Emails a new verification code and invalidates the previous one. The attempt's `expiresAt` and wrong-code count carry over. Resending before `resendAfter` is a `429` with `Retry-After`.
|
|
469
|
+
*/
|
|
470
|
+
post: operations["resendAuthenticationAttempt"];
|
|
471
|
+
delete?: never;
|
|
472
|
+
options?: never;
|
|
473
|
+
head?: never;
|
|
474
|
+
patch?: never;
|
|
475
|
+
trace?: never;
|
|
476
|
+
};
|
|
411
477
|
"/v2/pods": {
|
|
412
478
|
parameters: {
|
|
413
479
|
query?: never;
|
|
@@ -643,6 +709,55 @@ interface paths {
|
|
|
643
709
|
patch?: never;
|
|
644
710
|
trace?: never;
|
|
645
711
|
};
|
|
712
|
+
"/v2/pods/{id}/exec": {
|
|
713
|
+
parameters: {
|
|
714
|
+
query?: never;
|
|
715
|
+
header?: never;
|
|
716
|
+
path: {
|
|
717
|
+
/**
|
|
718
|
+
* @description Pod identifier
|
|
719
|
+
* @example pod_abc123
|
|
720
|
+
*/
|
|
721
|
+
id: string;
|
|
722
|
+
};
|
|
723
|
+
cookie?: never;
|
|
724
|
+
};
|
|
725
|
+
get?: never;
|
|
726
|
+
put?: never;
|
|
727
|
+
/**
|
|
728
|
+
* Run a command in a pod
|
|
729
|
+
* @description Runs one command inside the pod's container and returns its stdout,
|
|
730
|
+
* stderr and exit code once it finishes. No SSH key, public IP or exposed
|
|
731
|
+
* port is needed, and it works with any image.
|
|
732
|
+
*
|
|
733
|
+
* `command` is an argv array, run directly and never through a shell. For
|
|
734
|
+
* pipes, redirects or globbing pass `["sh", "-c", "..."]`.
|
|
735
|
+
*
|
|
736
|
+
* A command that exits non-zero is a result, not an error: the call
|
|
737
|
+
* answers `200` with `exitCode` set. A command still running after
|
|
738
|
+
* `timeoutSeconds` (1-25, default 20) answers `200` with
|
|
739
|
+
* `timedOut: true` and a null `exitCode`. `timedOut` means the call
|
|
740
|
+
* stopped waiting, not that the command was stopped: it may keep
|
|
741
|
+
* running in the container.
|
|
742
|
+
*
|
|
743
|
+
* `stdout` and `stderr` are each capped at 1 MiB. Output past the cap is
|
|
744
|
+
* cut and `truncated` is `true`.
|
|
745
|
+
*
|
|
746
|
+
* The pod must be running with its container up, otherwise this answers
|
|
747
|
+
* `409`; while the container is still starting, the `409` carries
|
|
748
|
+
* `Retry-After`. A pod whose machine has not been updated for exec yet
|
|
749
|
+
* answers `503` with `Retry-After`.
|
|
750
|
+
*
|
|
751
|
+
* `X-Team-Id` is not applied on this route: it reaches only pods owned by
|
|
752
|
+
* the caller's own account.
|
|
753
|
+
*/
|
|
754
|
+
post: operations["execPod"];
|
|
755
|
+
delete?: never;
|
|
756
|
+
options?: never;
|
|
757
|
+
head?: never;
|
|
758
|
+
patch?: never;
|
|
759
|
+
trace?: never;
|
|
760
|
+
};
|
|
646
761
|
"/v2/clusters": {
|
|
647
762
|
parameters: {
|
|
648
763
|
query?: never;
|
|
@@ -3589,6 +3704,75 @@ interface components {
|
|
|
3589
3704
|
*/
|
|
3590
3705
|
keys: string[];
|
|
3591
3706
|
};
|
|
3707
|
+
CreateAuthenticationAttemptRequest: {
|
|
3708
|
+
/**
|
|
3709
|
+
* Format: email
|
|
3710
|
+
* @description Address to send the verification code to. It may belong to an existing account or a new one.
|
|
3711
|
+
* @example owner@example.com
|
|
3712
|
+
*/
|
|
3713
|
+
email: string;
|
|
3714
|
+
/**
|
|
3715
|
+
* @description Name of the API key issued when verification succeeds.
|
|
3716
|
+
* @example laptop-cli
|
|
3717
|
+
*/
|
|
3718
|
+
keyName: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* @description Unpadded base64url SHA-256 hash of a random `codeVerifier` the caller keeps private. Verify and resend require the matching verifier.
|
|
3721
|
+
* @example E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
|
|
3722
|
+
*/
|
|
3723
|
+
codeChallenge: string;
|
|
3724
|
+
};
|
|
3725
|
+
VerifyAuthenticationAttemptRequest: {
|
|
3726
|
+
/**
|
|
3727
|
+
* @description Verification code from the email.
|
|
3728
|
+
* @example 123456
|
|
3729
|
+
*/
|
|
3730
|
+
code: string;
|
|
3731
|
+
codeVerifier: components["schemas"]["CodeVerifier"];
|
|
3732
|
+
};
|
|
3733
|
+
ResendAuthenticationAttemptRequest: {
|
|
3734
|
+
codeVerifier: components["schemas"]["CodeVerifier"];
|
|
3735
|
+
};
|
|
3736
|
+
/**
|
|
3737
|
+
* @description The random secret whose SHA-256 hash was sent as `codeChallenge`.
|
|
3738
|
+
* @example dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
|
|
3739
|
+
*/
|
|
3740
|
+
CodeVerifier: string;
|
|
3741
|
+
AuthenticationAttempt: {
|
|
3742
|
+
/**
|
|
3743
|
+
* @description Identifies the attempt in verify and resend.
|
|
3744
|
+
* @example att_3kq9x81mzp
|
|
3745
|
+
*/
|
|
3746
|
+
attemptId: string;
|
|
3747
|
+
/**
|
|
3748
|
+
* Format: date-time
|
|
3749
|
+
* @description When the attempt stops accepting codes. Resending does not extend it.
|
|
3750
|
+
* @example 2026-10-16T18:10:00Z
|
|
3751
|
+
*/
|
|
3752
|
+
expiresAt: string;
|
|
3753
|
+
/**
|
|
3754
|
+
* Format: date-time
|
|
3755
|
+
* @description Earliest time a resend is accepted.
|
|
3756
|
+
* @example 2026-10-16T18:00:30Z
|
|
3757
|
+
*/
|
|
3758
|
+
resendAfter: string;
|
|
3759
|
+
};
|
|
3760
|
+
AuthenticationAttemptResult: {
|
|
3761
|
+
/** @example user_2abc9xyz */
|
|
3762
|
+
userId: string;
|
|
3763
|
+
credential: {
|
|
3764
|
+
/**
|
|
3765
|
+
* @description Identifies the key in the console, where it can be revoked.
|
|
3766
|
+
* @example key_7Rk2m0pq
|
|
3767
|
+
*/
|
|
3768
|
+
id: string;
|
|
3769
|
+
/**
|
|
3770
|
+
* @description The raw API key. It is returned once, so store it before doing anything else.
|
|
3771
|
+
* @example rpa_EXAMPLEONLYEXAMPLEONLYEXAMPLEONLY
|
|
3772
|
+
*/
|
|
3773
|
+
apiKey: string;
|
|
3774
|
+
};
|
|
3775
|
+
};
|
|
3592
3776
|
/** @description An account-scoped secret: an encrypted string stored by Runpod, referenced from pod, serverless, and template environment variables with the `{{ RUNPOD_SECRET_<name> }}` placeholder, substituted with the secret's value when the pod or worker boots. The value is write-only and never returned by the API. */
|
|
3593
3777
|
Secret: {
|
|
3594
3778
|
/**
|
|
@@ -3791,7 +3975,7 @@ interface components {
|
|
|
3791
3975
|
* access: injects a `PUBLIC_KEY` environment variable carrying
|
|
3792
3976
|
* your account's registered SSH public keys, unless the request
|
|
3793
3977
|
* already sets one. **Requires registered keys** (`PUT
|
|
3794
|
-
* /v2/account/ssh-keys`)
|
|
3978
|
+
* /v2/account/ssh-keys`); with none registered the flag does
|
|
3795
3979
|
* nothing and the pod has no SSH access. Only images that honor
|
|
3796
3980
|
* the convention start sshd from it (all Runpod official images
|
|
3797
3981
|
* do). Connect using the pod's `ssh` block; the `ssh.direct`
|
|
@@ -3849,6 +4033,75 @@ interface components {
|
|
|
3849
4033
|
PodActionRequest: {
|
|
3850
4034
|
action: components["schemas"]["PodAction"];
|
|
3851
4035
|
};
|
|
4036
|
+
PodExecRequest: {
|
|
4037
|
+
/**
|
|
4038
|
+
* @description Command to run, as an argv array of 1-256 arguments of at most 4096
|
|
4039
|
+
* characters each. It is run directly, never through a shell; for
|
|
4040
|
+
* pipes, redirects or globbing pass `["sh", "-c", "..."]`. The first
|
|
4041
|
+
* element, the program, must contain a non-whitespace character;
|
|
4042
|
+
* later arguments may be empty. No argument may contain a NUL
|
|
4043
|
+
* character.
|
|
4044
|
+
* @example [
|
|
4045
|
+
* "nvidia-smi",
|
|
4046
|
+
* "--query-gpu=name,memory.used",
|
|
4047
|
+
* "--format=csv"
|
|
4048
|
+
* ]
|
|
4049
|
+
*/
|
|
4050
|
+
command: [
|
|
4051
|
+
string
|
|
4052
|
+
];
|
|
4053
|
+
/**
|
|
4054
|
+
* @description How long the call waits for the command to finish, in seconds. A
|
|
4055
|
+
* command still running at this point returns with `timedOut: true`.
|
|
4056
|
+
* @default 20
|
|
4057
|
+
* @example 10
|
|
4058
|
+
*/
|
|
4059
|
+
timeoutSeconds?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* @description Absolute working directory for the command, at most 1024 characters
|
|
4062
|
+
* and without control characters. Defaults to the image's `WORKDIR`.
|
|
4063
|
+
* @example /workspace
|
|
4064
|
+
*/
|
|
4065
|
+
cwd?: string;
|
|
4066
|
+
/**
|
|
4067
|
+
* @description Up to 64 environment variables added to the container's environment
|
|
4068
|
+
* for this command only. A name is 1-256 characters and must not
|
|
4069
|
+
* contain `=` or a NUL character; a value is at most 16384 characters
|
|
4070
|
+
* and must not contain a NUL character.
|
|
4071
|
+
* @example {
|
|
4072
|
+
* "HF_HOME": "/workspace/hf"
|
|
4073
|
+
* }
|
|
4074
|
+
*/
|
|
4075
|
+
env?: {
|
|
4076
|
+
[key: string]: string;
|
|
4077
|
+
};
|
|
4078
|
+
};
|
|
4079
|
+
PodExecResult: {
|
|
4080
|
+
/**
|
|
4081
|
+
* @description The command's standard output, as UTF-8 with invalid bytes
|
|
4082
|
+
* replaced. Capped at 1 MiB; see `truncated`.
|
|
4083
|
+
*/
|
|
4084
|
+
stdout: string;
|
|
4085
|
+
/**
|
|
4086
|
+
* @description The command's standard error, as UTF-8 with invalid bytes
|
|
4087
|
+
* replaced. Capped at 1 MiB; see `truncated`.
|
|
4088
|
+
*/
|
|
4089
|
+
stderr: string;
|
|
4090
|
+
/**
|
|
4091
|
+
* @description The command's exit code. A non-zero code is a result, not an error.
|
|
4092
|
+
* Null only when `timedOut` is `true`.
|
|
4093
|
+
*/
|
|
4094
|
+
exitCode: number | null;
|
|
4095
|
+
/**
|
|
4096
|
+
* @description The call stopped waiting at `timeoutSeconds`. It does not mean the
|
|
4097
|
+
* command was stopped: it may still be running inside the container.
|
|
4098
|
+
*/
|
|
4099
|
+
timedOut: boolean;
|
|
4100
|
+
/** @description `stdout` or `stderr` reached the 1 MiB cap and was cut. */
|
|
4101
|
+
truncated: boolean;
|
|
4102
|
+
/** @description Wall time of the command as measured on the pod's machine, in milliseconds. */
|
|
4103
|
+
durationMs: number;
|
|
4104
|
+
};
|
|
3852
4105
|
/** @description A bare list of pods. `GET /v2/clusters/{id}/pods` returns it as-is (a cluster's members are a small, complete set); `GET /v2/pods` composes it with the pagination block via ListPodsResponse. */
|
|
3853
4106
|
PodList: {
|
|
3854
4107
|
pods: components["schemas"]["Pod"][];
|
|
@@ -6913,6 +7166,205 @@ interface operations {
|
|
|
6913
7166
|
};
|
|
6914
7167
|
};
|
|
6915
7168
|
};
|
|
7169
|
+
createAuthenticationAttempt: {
|
|
7170
|
+
parameters: {
|
|
7171
|
+
query?: never;
|
|
7172
|
+
header: {
|
|
7173
|
+
/**
|
|
7174
|
+
* @description Use an unpredictable unique key, such as a UUID, for each new attempt. Retrying with the same key and body returns the same attempt without sending another email. For the same email, the same key with a different body is a `422`.
|
|
7175
|
+
* @example 0f8c2d4e-6a1b-4c3d-9e7f-1a2b3c4d5e6f
|
|
7176
|
+
*/
|
|
7177
|
+
"Idempotency-Key": string;
|
|
7178
|
+
};
|
|
7179
|
+
path?: never;
|
|
7180
|
+
cookie?: never;
|
|
7181
|
+
};
|
|
7182
|
+
requestBody: {
|
|
7183
|
+
content: {
|
|
7184
|
+
"application/json": components["schemas"]["CreateAuthenticationAttemptRequest"];
|
|
7185
|
+
};
|
|
7186
|
+
};
|
|
7187
|
+
responses: {
|
|
7188
|
+
/** @description Created. A verification code was emailed. */
|
|
7189
|
+
201: {
|
|
7190
|
+
headers: {
|
|
7191
|
+
[name: string]: unknown;
|
|
7192
|
+
};
|
|
7193
|
+
content: {
|
|
7194
|
+
"application/json": components["schemas"]["AuthenticationAttempt"];
|
|
7195
|
+
};
|
|
7196
|
+
};
|
|
7197
|
+
/** @description The request is malformed or its body could not be read. */
|
|
7198
|
+
400: {
|
|
7199
|
+
headers: {
|
|
7200
|
+
[name: string]: unknown;
|
|
7201
|
+
};
|
|
7202
|
+
content: {
|
|
7203
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7204
|
+
};
|
|
7205
|
+
};
|
|
7206
|
+
/** @description The incoming request body exceeds 4096 bytes (4 KiB). */
|
|
7207
|
+
413: {
|
|
7208
|
+
headers: {
|
|
7209
|
+
[name: string]: unknown;
|
|
7210
|
+
};
|
|
7211
|
+
content: {
|
|
7212
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7213
|
+
};
|
|
7214
|
+
};
|
|
7215
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7216
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7217
|
+
/** @description Error */
|
|
7218
|
+
default: {
|
|
7219
|
+
headers: {
|
|
7220
|
+
[name: string]: unknown;
|
|
7221
|
+
};
|
|
7222
|
+
content: {
|
|
7223
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7224
|
+
};
|
|
7225
|
+
};
|
|
7226
|
+
};
|
|
7227
|
+
};
|
|
7228
|
+
verifyAuthenticationAttempt: {
|
|
7229
|
+
parameters: {
|
|
7230
|
+
query?: never;
|
|
7231
|
+
header?: never;
|
|
7232
|
+
path: {
|
|
7233
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
7234
|
+
id: string;
|
|
7235
|
+
};
|
|
7236
|
+
cookie?: never;
|
|
7237
|
+
};
|
|
7238
|
+
requestBody: {
|
|
7239
|
+
content: {
|
|
7240
|
+
"application/json": components["schemas"]["VerifyAuthenticationAttemptRequest"];
|
|
7241
|
+
};
|
|
7242
|
+
};
|
|
7243
|
+
responses: {
|
|
7244
|
+
/** @description OK. The attempt is consumed and the key is issued. */
|
|
7245
|
+
200: {
|
|
7246
|
+
headers: {
|
|
7247
|
+
"Cache-Control": "no-store";
|
|
7248
|
+
[name: string]: unknown;
|
|
7249
|
+
};
|
|
7250
|
+
content: {
|
|
7251
|
+
"application/json": components["schemas"]["AuthenticationAttemptResult"];
|
|
7252
|
+
};
|
|
7253
|
+
};
|
|
7254
|
+
/** @description The request is malformed or its body could not be read. */
|
|
7255
|
+
400: {
|
|
7256
|
+
headers: {
|
|
7257
|
+
[name: string]: unknown;
|
|
7258
|
+
};
|
|
7259
|
+
content: {
|
|
7260
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7261
|
+
};
|
|
7262
|
+
};
|
|
7263
|
+
/** @description The account requires SSO or MFA, or belongs to an organization. Sign in through the console instead. */
|
|
7264
|
+
403: {
|
|
7265
|
+
headers: {
|
|
7266
|
+
[name: string]: unknown;
|
|
7267
|
+
};
|
|
7268
|
+
content: {
|
|
7269
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7270
|
+
};
|
|
7271
|
+
};
|
|
7272
|
+
/** @description No usable attempt matches this id and `codeVerifier`. It does not exist, expired, already issued a key, or locked after five wrong codes. */
|
|
7273
|
+
404: {
|
|
7274
|
+
headers: {
|
|
7275
|
+
[name: string]: unknown;
|
|
7276
|
+
};
|
|
7277
|
+
content: {
|
|
7278
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7279
|
+
};
|
|
7280
|
+
};
|
|
7281
|
+
/** @description The incoming request body exceeds 4096 bytes (4 KiB). */
|
|
7282
|
+
413: {
|
|
7283
|
+
headers: {
|
|
7284
|
+
[name: string]: unknown;
|
|
7285
|
+
};
|
|
7286
|
+
content: {
|
|
7287
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7288
|
+
};
|
|
7289
|
+
};
|
|
7290
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7291
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7292
|
+
/** @description Error */
|
|
7293
|
+
default: {
|
|
7294
|
+
headers: {
|
|
7295
|
+
[name: string]: unknown;
|
|
7296
|
+
};
|
|
7297
|
+
content: {
|
|
7298
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7299
|
+
};
|
|
7300
|
+
};
|
|
7301
|
+
};
|
|
7302
|
+
};
|
|
7303
|
+
resendAuthenticationAttempt: {
|
|
7304
|
+
parameters: {
|
|
7305
|
+
query?: never;
|
|
7306
|
+
header?: never;
|
|
7307
|
+
path: {
|
|
7308
|
+
/** @description The `attemptId` returned when the attempt started. */
|
|
7309
|
+
id: string;
|
|
7310
|
+
};
|
|
7311
|
+
cookie?: never;
|
|
7312
|
+
};
|
|
7313
|
+
requestBody: {
|
|
7314
|
+
content: {
|
|
7315
|
+
"application/json": components["schemas"]["ResendAuthenticationAttemptRequest"];
|
|
7316
|
+
};
|
|
7317
|
+
};
|
|
7318
|
+
responses: {
|
|
7319
|
+
/** @description OK. A new code was emailed. */
|
|
7320
|
+
200: {
|
|
7321
|
+
headers: {
|
|
7322
|
+
[name: string]: unknown;
|
|
7323
|
+
};
|
|
7324
|
+
content: {
|
|
7325
|
+
"application/json": components["schemas"]["AuthenticationAttempt"];
|
|
7326
|
+
};
|
|
7327
|
+
};
|
|
7328
|
+
/** @description The request is malformed or its body could not be read. */
|
|
7329
|
+
400: {
|
|
7330
|
+
headers: {
|
|
7331
|
+
[name: string]: unknown;
|
|
7332
|
+
};
|
|
7333
|
+
content: {
|
|
7334
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7335
|
+
};
|
|
7336
|
+
};
|
|
7337
|
+
/** @description No usable attempt matches this id and `codeVerifier`. It does not exist, expired, already issued a key, or locked after five wrong codes. */
|
|
7338
|
+
404: {
|
|
7339
|
+
headers: {
|
|
7340
|
+
[name: string]: unknown;
|
|
7341
|
+
};
|
|
7342
|
+
content: {
|
|
7343
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7344
|
+
};
|
|
7345
|
+
};
|
|
7346
|
+
/** @description The incoming request body exceeds 4096 bytes (4 KiB). */
|
|
7347
|
+
413: {
|
|
7348
|
+
headers: {
|
|
7349
|
+
[name: string]: unknown;
|
|
7350
|
+
};
|
|
7351
|
+
content: {
|
|
7352
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7353
|
+
};
|
|
7354
|
+
};
|
|
7355
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7356
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7357
|
+
/** @description Error */
|
|
7358
|
+
default: {
|
|
7359
|
+
headers: {
|
|
7360
|
+
[name: string]: unknown;
|
|
7361
|
+
};
|
|
7362
|
+
content: {
|
|
7363
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7364
|
+
};
|
|
7365
|
+
};
|
|
7366
|
+
};
|
|
7367
|
+
};
|
|
6916
7368
|
listPods: {
|
|
6917
7369
|
parameters: {
|
|
6918
7370
|
query?: {
|
|
@@ -7312,6 +7764,128 @@ interface operations {
|
|
|
7312
7764
|
};
|
|
7313
7765
|
};
|
|
7314
7766
|
};
|
|
7767
|
+
execPod: {
|
|
7768
|
+
parameters: {
|
|
7769
|
+
query?: never;
|
|
7770
|
+
header?: never;
|
|
7771
|
+
path: {
|
|
7772
|
+
/**
|
|
7773
|
+
* @description Pod identifier
|
|
7774
|
+
* @example pod_abc123
|
|
7775
|
+
*/
|
|
7776
|
+
id: string;
|
|
7777
|
+
};
|
|
7778
|
+
cookie?: never;
|
|
7779
|
+
};
|
|
7780
|
+
requestBody: {
|
|
7781
|
+
content: {
|
|
7782
|
+
"application/json": components["schemas"]["PodExecRequest"];
|
|
7783
|
+
};
|
|
7784
|
+
};
|
|
7785
|
+
responses: {
|
|
7786
|
+
/** @description The command finished or the call stopped waiting for it. A non-zero `exitCode` is a result, not an error. */
|
|
7787
|
+
200: {
|
|
7788
|
+
headers: {
|
|
7789
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7790
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7791
|
+
[name: string]: unknown;
|
|
7792
|
+
};
|
|
7793
|
+
content: {
|
|
7794
|
+
"application/json": components["schemas"]["PodExecResult"];
|
|
7795
|
+
};
|
|
7796
|
+
};
|
|
7797
|
+
400: components["responses"]["BadRequestError"];
|
|
7798
|
+
401: components["responses"]["UnauthorizedError"];
|
|
7799
|
+
403: components["responses"]["ForbiddenError"];
|
|
7800
|
+
404: components["responses"]["NotFoundError"];
|
|
7801
|
+
/**
|
|
7802
|
+
* @description The pod is not running, or its container has not started yet. A
|
|
7803
|
+
* container that is starting answers with `Retry-After`.
|
|
7804
|
+
*/
|
|
7805
|
+
409: {
|
|
7806
|
+
headers: {
|
|
7807
|
+
/**
|
|
7808
|
+
* @description Seconds to wait before retrying. Sent only while the pod's container is starting.
|
|
7809
|
+
* @example 5
|
|
7810
|
+
*/
|
|
7811
|
+
"Retry-After"?: number;
|
|
7812
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7813
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7814
|
+
[name: string]: unknown;
|
|
7815
|
+
};
|
|
7816
|
+
content: {
|
|
7817
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7818
|
+
};
|
|
7819
|
+
};
|
|
7820
|
+
413: components["responses"]["RequestTooLargeError"];
|
|
7821
|
+
422: components["responses"]["UnprocessableEntityError"];
|
|
7822
|
+
429: components["responses"]["TooManyRequestsError"];
|
|
7823
|
+
/**
|
|
7824
|
+
* @description The call did not complete. When the pod could not be looked up, or
|
|
7825
|
+
* its machine or the exec service could not be reached, the command
|
|
7826
|
+
* did not start: retry the call. When the command was sent but no
|
|
7827
|
+
* usable answer came back, it may still be running: check before you
|
|
7828
|
+
* retry. When the result could not be read, the command ran.
|
|
7829
|
+
*/
|
|
7830
|
+
502: {
|
|
7831
|
+
headers: {
|
|
7832
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7833
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7834
|
+
[name: string]: unknown;
|
|
7835
|
+
};
|
|
7836
|
+
content: {
|
|
7837
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7838
|
+
};
|
|
7839
|
+
};
|
|
7840
|
+
/**
|
|
7841
|
+
* @description Command execution is not available for this pod right now: its
|
|
7842
|
+
* machine has not been updated for exec, execution is busy, or it is
|
|
7843
|
+
* temporarily unavailable. The pod itself is unaffected; retry after
|
|
7844
|
+
* `Retry-After`.
|
|
7845
|
+
*/
|
|
7846
|
+
503: {
|
|
7847
|
+
headers: {
|
|
7848
|
+
/**
|
|
7849
|
+
* @description Seconds to wait before retrying.
|
|
7850
|
+
* @example 30
|
|
7851
|
+
*/
|
|
7852
|
+
"Retry-After"?: number;
|
|
7853
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7854
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7855
|
+
[name: string]: unknown;
|
|
7856
|
+
};
|
|
7857
|
+
content: {
|
|
7858
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7859
|
+
};
|
|
7860
|
+
};
|
|
7861
|
+
/**
|
|
7862
|
+
* @description The pod's machine, or the exec service in front of it, did not
|
|
7863
|
+
* answer in time. The command may still be running: check before you
|
|
7864
|
+
* retry.
|
|
7865
|
+
*/
|
|
7866
|
+
504: {
|
|
7867
|
+
headers: {
|
|
7868
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7869
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7870
|
+
[name: string]: unknown;
|
|
7871
|
+
};
|
|
7872
|
+
content: {
|
|
7873
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7874
|
+
};
|
|
7875
|
+
};
|
|
7876
|
+
/** @description Error */
|
|
7877
|
+
default: {
|
|
7878
|
+
headers: {
|
|
7879
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
7880
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
7881
|
+
[name: string]: unknown;
|
|
7882
|
+
};
|
|
7883
|
+
content: {
|
|
7884
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
7885
|
+
};
|
|
7886
|
+
};
|
|
7887
|
+
};
|
|
7888
|
+
};
|
|
7315
7889
|
listClusters: {
|
|
7316
7890
|
parameters: {
|
|
7317
7891
|
query?: {
|
|
@@ -8690,6 +9264,17 @@ interface operations {
|
|
|
8690
9264
|
401: components["responses"]["UnauthorizedError"];
|
|
8691
9265
|
403: components["responses"]["ForbiddenError"];
|
|
8692
9266
|
404: components["responses"]["NotFoundError"];
|
|
9267
|
+
/** @description The volume was created less than five minutes ago. Retry after the time given in the detail. */
|
|
9268
|
+
409: {
|
|
9269
|
+
headers: {
|
|
9270
|
+
RateLimit: components["headers"]["RateLimit"];
|
|
9271
|
+
"RateLimit-Policy": components["headers"]["RateLimit-Policy"];
|
|
9272
|
+
[name: string]: unknown;
|
|
9273
|
+
};
|
|
9274
|
+
content: {
|
|
9275
|
+
"application/problem+json": components["schemas"]["ErrorResponse"];
|
|
9276
|
+
};
|
|
9277
|
+
};
|
|
8693
9278
|
429: components["responses"]["TooManyRequestsError"];
|
|
8694
9279
|
/** @description Error */
|
|
8695
9280
|
default: {
|
package/package.json
CHANGED