Skip to content

Commit 82a1f27

Browse files
author
Bitbucket Pipeline
committed
Update OpenAPI spec preview from vast@cd13189d (PR #4175)
1 parent f9a8e40 commit 82a1f27

324 files changed

Lines changed: 30265 additions & 18655 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api-reference/openapi.yaml‎

Lines changed: 12753 additions & 7032 deletions
Large diffs are not rendered by default.

‎api-reference/openapi/yaml/auto_delete_api_v0_auth_apikeys_id_23db61.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Vast.ai API (auto-generated endpoint)
4+
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
5+
and regenerate.
6+
version: 1.0.0
7+
servers:
8+
- url: https://console.vast.ai
9+
description: Production server
10+
paths:
11+
/api/v0/auth/apikeys/{id}/:
12+
delete:
13+
summary: Delete API Key
14+
tags:
15+
- Accounts
16+
description: Deletes a user-created API key by ID; primary and non-user-created keys cannot be deleted.
17+
security:
18+
- BearerAuth: []
19+
x-scope: user_write
20+
x-rateLimit: 2
21+
parameters:
22+
- name: id
23+
in: path
24+
required: true
25+
schema:
26+
type: integer
27+
description: ID of the API key to delete
28+
responses:
29+
'200':
30+
description: Returns "Successfully Deleted API Key" on success.
31+
'400':
32+
description: API Key ID not provided ("API Key ID not provided."), only user-created API keys can be deleted ("Only
33+
user-created API keys can be deleted."), or cannot delete primary key ("You cannot delete your primary key.").
34+
content:
35+
application/json:
36+
schema:
37+
$ref: '#/components/schemas/Error'
38+
'401':
39+
description: Not authenticated ("You must be logged in to delete an API key.") or key belongs to a different user
40+
("You do not have permission to delete this API Key.").
41+
content:
42+
application/json:
43+
schema:
44+
$ref: '#/components/schemas/Error'
45+
'404':
46+
description: API key not found ("API Key not found.").
47+
content:
48+
application/json:
49+
schema:
50+
$ref: '#/components/schemas/Error'
51+
components:
52+
schemas:
53+
Error:
54+
type: object
55+
properties:
56+
error:
57+
type: string
58+
msg:
59+
type: string

‎api-reference/openapi/yaml/auto_delete_api_v0_auth_sessions_1c4181.yaml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Vast.ai API (auto-generated endpoint)
4+
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
5+
and regenerate.
6+
version: 1.0.0
7+
servers:
8+
- url: https://console.vast.ai
9+
description: Production server
10+
paths:
11+
/api/v0/auth/sessions/:
12+
delete:
13+
summary: Delete Sessions
14+
tags:
15+
- Accounts
16+
description: Deletes one or all active sessions for the authenticated user by session ID, or all sessions at once.
17+
security:
18+
- BearerAuth: []
19+
x-scope: user_write
20+
x-rateLimit: 2
21+
requestBody:
22+
content:
23+
application/json:
24+
schema:
25+
type: object
26+
properties:
27+
all:
28+
type: boolean
29+
description: Set to true to delete all active sessions at once
30+
example: true
31+
key_id:
32+
type: integer
33+
description: ID of a specific session key to delete; required if all is not set
34+
example: 55
35+
responses:
36+
'200':
37+
description: Returns {success, msg} where msg is "All active sessions deleted.", "No active sessions found.", "Session
38+
{id} deleted.", or "Session {id} not found."
39+
content:
40+
application/json:
41+
schema:
42+
type: object
43+
properties:
44+
success:
45+
type: boolean
46+
description: Whether deletion succeeded
47+
msg:
48+
type: string
49+
description: Confirmation or not-found message
50+
example:
51+
success: true
52+
msg: All active sessions deleted.
53+
'400':
54+
description: No session key id provided ("No session key id provided.").
55+
content:
56+
application/json:
57+
schema:
58+
$ref: '#/components/schemas/Error'
59+
'401':
60+
description: Not logged in ("You must be logged in to delete sessions.") or attempting to delete another user's
61+
sessions ("You do not have permission to delete someone else's sessions.").
62+
content:
63+
application/json:
64+
schema:
65+
$ref: '#/components/schemas/Error'
66+
components:
67+
schemas:
68+
Error:
69+
type: object
70+
properties:
71+
error:
72+
type: string
73+
msg:
74+
type: string

‎api-reference/openapi/yaml/auto_delete_api_v0_autojobs_id_3facde.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Vast.ai API (auto-generated endpoint)
4+
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
5+
and regenerate.
6+
version: 1.0.0
7+
servers:
8+
- url: https://console.vast.ai
9+
description: Production server
10+
paths:
11+
/api/v0/autojobs/{id}/:
12+
delete:
13+
summary: Delete Autojob Workergroup
14+
tags:
15+
- Serverless
16+
description: Soft-deletes a workergroup by ID, terminating any associated worker instances; cascades to the parent deployment
17+
if one exists.
18+
security: []
19+
x-rateLimit: 3
20+
parameters:
21+
- name: id
22+
in: path
23+
required: true
24+
schema:
25+
type: integer
26+
description: Numeric ID of the workergroup to delete.
27+
responses:
28+
'200':
29+
description: 'Returns {success: true}'
30+
content:
31+
application/json:
32+
schema:
33+
type: object
34+
properties:
35+
success:
36+
type: boolean
37+
description: Always true on success.
38+
example:
39+
success: true
40+
'400':
41+
description: 'Invalid arguments: "id must be an integer" or "Invalid autojob ID"'
42+
content:
43+
application/json:
44+
schema:
45+
$ref: '#/components/schemas/Error'
46+
'404':
47+
description: '"No autojob by that id is available."'
48+
content:
49+
application/json:
50+
schema:
51+
$ref: '#/components/schemas/Error'
52+
components:
53+
schemas:
54+
Error:
55+
type: object
56+
properties:
57+
error:
58+
type: string
59+
msg:
60+
type: string

‎api-reference/openapi/yaml/auto_delete_api_v0_commands_copy_direct_6443b6.yaml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Vast.ai API (auto-generated endpoint)
4+
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
5+
and regenerate.
6+
version: 1.0.0
7+
servers:
8+
- url: https://console.vast.ai
9+
description: Production server
10+
paths:
11+
/api/v0/commands/copy_direct/:
12+
delete:
13+
summary: Cancel Direct Copy
14+
tags:
15+
- Instances
16+
description: Cancels an in-progress direct copy operation on the destination instance.
17+
security:
18+
- BearerAuth: []
19+
x-scope: instance_write
20+
x-rateLimit: 3.5
21+
requestBody:
22+
content:
23+
application/json:
24+
schema:
25+
type: object
26+
properties:
27+
dst_id:
28+
type: string
29+
description: ID of the copy instance target to cancel.
30+
responses:
31+
'200':
32+
description: 'Returns {success: true} when the cancel task is sent.'
33+
content:
34+
application/json:
35+
schema:
36+
type: object
37+
properties:
38+
success:
39+
type: boolean
40+
description: True when cancel command was sent
41+
error:
42+
type: string
43+
description: Error code if success is false
44+
msg:
45+
type: string
46+
description: Human-readable message
47+
example:
48+
success: true
49+
'400':
50+
description: 'Returns {success: false, error: "invalid_args", msg: "Invalid dst_id."} when dst_id is invalid, or
51+
{success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when dst_instance_id
52+
is None.'
53+
content:
54+
application/json:
55+
schema:
56+
$ref: '#/components/schemas/Error'
57+
components:
58+
schemas:
59+
Error:
60+
type: object
61+
properties:
62+
error:
63+
type: string
64+
msg:
65+
type: string

‎api-reference/openapi/yaml/auto_delete_api_v0_commands_rclone_cf30c2.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Vast.ai API (auto-generated endpoint)
4+
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
5+
and regenerate.
6+
version: 1.0.0
7+
servers:
8+
- url: https://console.vast.ai
9+
description: Production server
10+
paths:
11+
/api/v0/commands/rclone/:
12+
delete:
13+
summary: Cancel Remote Rclone Copy
14+
tags:
15+
- Instances
16+
description: Kills the running rclone process on the destination instance to cancel an in-progress cloud copy.
17+
security:
18+
- BearerAuth: []
19+
x-scope: instance_write
20+
x-rateLimit: 3.5
21+
requestBody:
22+
content:
23+
application/json:
24+
schema:
25+
type: object
26+
properties:
27+
dst_id:
28+
type: integer
29+
description: The destination instance ID of the sync operation to cancel.
30+
responses:
31+
'200':
32+
description: 'Returns {success: false, error: "invalid_arqgs", msg: "Invalid dst_id."} when the destination instance
33+
is invalid, or {success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when
34+
path is unavailable.'
35+
content:
36+
application/json:
37+
schema:
38+
type: object
39+
properties:
40+
success:
41+
type: boolean
42+
description: True when cancel command was sent
43+
error:
44+
type: string
45+
description: Error code if success is false
46+
msg:
47+
type: string
48+
description: Human-readable message
49+
example:
50+
success: true

‎api-reference/openapi/yaml/auto_delete_api_v0_commands_rsync_8f65cb.yaml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Vast.ai API (auto-generated endpoint)
4+
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
5+
and regenerate.
6+
version: 1.0.0
7+
servers:
8+
- url: https://console.vast.ai
9+
description: Production server
10+
paths:
11+
/api/v0/commands/rsync/:
12+
delete:
13+
summary: Cancel Remote Rsync Copy
14+
tags:
15+
- Instances
16+
description: Kills the running rsync process on the destination instance to cancel an in-progress copy operation.
17+
security:
18+
- BearerAuth: []
19+
x-scope: instance_write
20+
x-rateLimit: 3.5
21+
requestBody:
22+
content:
23+
application/json:
24+
schema:
25+
type: object
26+
properties:
27+
dst_id:
28+
type: string
29+
description: Instance ID of the rsync destination whose copy to cancel.
30+
example: '12346'
31+
responses:
32+
'200':
33+
description: 'Returns {success: false, error: "invalid_args", msg: "Invalid dst_id."} when the destination instance
34+
is invalid, or {success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when
35+
no path is available.'
36+
content:
37+
application/json:
38+
schema:
39+
type: object
40+
properties:
41+
success:
42+
type: boolean
43+
description: True when cancel command was sent
44+
error:
45+
type: string
46+
description: Error code if success is false
47+
msg:
48+
type: string
49+
description: Human-readable message
50+
example:
51+
success: true

0 commit comments

Comments
 (0)