Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17,525 changes: 10,237 additions & 7,288 deletions api-reference/openapi.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
openapi: 3.1.0
info:
title: Vast.ai API (auto-generated endpoint)
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
and regenerate.
version: 1.0.0
servers:
- url: https://console.vast.ai
description: Production server
paths:
/api/v0/auth/apikeys/{id}/:
delete:
summary: Delete API Key
tags:
- Accounts
description: Deletes a user-created API key by ID; primary and non-user-created keys cannot be deleted.
security:
- BearerAuth: []
x-scope: user_write
x-rateLimit: 2
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: ID of the API key to delete
responses:
'200':
description: Returns "Successfully Deleted API Key" on success.
'400':
description: API Key ID not provided ("API Key ID not provided."), only user-created API keys can be deleted ("Only
user-created API keys can be deleted."), or cannot delete primary key ("You cannot delete your primary key.").
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Not authenticated ("You must be logged in to delete an API key.") or key belongs to a different user
("You do not have permission to delete this API Key.").
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: API key not found ("API Key not found.").
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: string
msg:
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
openapi: 3.1.0
info:
title: Vast.ai API (auto-generated endpoint)
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
and regenerate.
version: 1.0.0
servers:
- url: https://console.vast.ai
description: Production server
paths:
/api/v0/autojobs/{id}/:
delete:
summary: Delete Autojob Workergroup
tags:
- Serverless
description: Soft-deletes a workergroup by ID, terminating any associated worker instances; cascades to the parent deployment
if one exists.
security: []
x-rateLimit: 3
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Numeric ID of the workergroup to delete.
responses:
'200':
description: 'Returns {success: true}'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Always true on success.
example:
success: true
'400':
description: 'Invalid arguments: "id must be an integer" or "Invalid autojob ID"'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: '"No autojob by that id is available."'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: string
msg:
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
openapi: 3.1.0
info:
title: Vast.ai API (auto-generated endpoint)
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
and regenerate.
version: 1.0.0
servers:
- url: https://console.vast.ai
description: Production server
paths:
/api/v0/commands/copy_direct/:
delete:
summary: Cancel Direct Copy
tags:
- Instances
description: Cancels an in-progress direct copy operation on the destination instance.
security:
- BearerAuth: []
x-scope: instance_write
x-rateLimit: 3.5
requestBody:
content:
application/json:
schema:
type: object
properties:
dst_id:
type: string
description: ID of the copy instance target to cancel.
responses:
'200':
description: 'Returns {success: true} when the cancel task is sent.'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: True when cancel command was sent
error:
type: string
description: Error code if success is false
msg:
type: string
description: Human-readable message
example:
success: true
'400':
description: 'Returns {success: false, error: "invalid_args", msg: "Invalid dst_id."} when dst_id is invalid, or
{success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when dst_instance_id
is None.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: string
msg:
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
openapi: 3.1.0
info:
title: Vast.ai API (auto-generated endpoint)
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
and regenerate.
version: 1.0.0
servers:
- url: https://console.vast.ai
description: Production server
paths:
/api/v0/commands/rclone/:
delete:
summary: Cancel Remote Rclone Copy
tags:
- Instances
description: Kills the running rclone process on the destination instance to cancel an in-progress cloud copy.
security:
- BearerAuth: []
x-scope: instance_write
x-rateLimit: 3.5
requestBody:
content:
application/json:
schema:
type: object
properties:
dst_id:
type: integer
description: The destination instance ID of the sync operation to cancel.
responses:
'200':
description: 'Returns {success: false, error: "invalid_arqgs", msg: "Invalid dst_id."} when the destination instance
is invalid, or {success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when
path is unavailable.'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: True when cancel command was sent
error:
type: string
description: Error code if success is false
msg:
type: string
description: Human-readable message
example:
success: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
openapi: 3.1.0
info:
title: Vast.ai API (auto-generated endpoint)
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
and regenerate.
version: 1.0.0
servers:
- url: https://console.vast.ai
description: Production server
paths:
/api/v0/commands/rsync/:
delete:
summary: Cancel Remote Rsync Copy
tags:
- Instances
description: Kills the running rsync process on the destination instance to cancel an in-progress copy operation.
security:
- BearerAuth: []
x-scope: instance_write
x-rateLimit: 3.5
requestBody:
content:
application/json:
schema:
type: object
properties:
dst_id:
type: string
description: Instance ID of the rsync destination whose copy to cancel.
example: '12346'
responses:
'200':
description: 'Returns {success: false, error: "invalid_args", msg: "Invalid dst_id."} when the destination instance
is invalid, or {success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when
no path is available.'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: True when cancel command was sent
error:
type: string
description: Error code if success is false
msg:
type: string
description: Human-readable message
example:
success: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
openapi: 3.1.0
info:
title: Vast.ai API (auto-generated endpoint)
description: Auto-generated from vast backend code introspection. Do not hand-edit — change web/ code or scripts/openapi_overrides.json
and regenerate.
version: 1.0.0
servers:
- url: https://console.vast.ai
description: Production server
paths:
/api/v0/commands/schedule_job/{id}/:
delete:
summary: Delete Scheduled Job
tags:
- Instances
description: Deletes a scheduled job by ID, scoped to the authenticated user.
security:
- BearerAuth: []
x-scope: instance_write
x-rateLimit: 3.5
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: ID of the scheduled job to delete (URL path parameter).
responses:
'200':
description: 'Scheduled job deleted successfully; returns {success: true, msg: "Scheduled job <id> deleted successfully"}'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Always true on success
msg:
type: string
description: Human-readable confirmation message
example:
success: true
msg: Scheduled job 42 deleted successfully
'400':
description: 'Missing scheduled job ID; returns {error: "missing_input", msg: "scheduled_job''s id is required."}'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: 'No scheduled job found with the given ID; returns {error: "not_found"}'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: string
msg:
type: string
Loading
Loading