e2b
Version:
E2B SDK that give agents cloud environments
1,498 lines (1,497 loc) • 293 kB
text/typescript
import createClient from 'openapi-fetch';
import { Transport, Client } from '@connectrpc/connect';
import { Message } from '@bufbuild/protobuf';
import { GenService, GenMessage } from '@bufbuild/protobuf/codegenv2';
import { PathLike } from 'node:fs';
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
interface paths {
"/sandboxes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all running sandboxes */
get: {
parameters: {
query?: {
/** @description Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded. */
metadata?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned all running sandboxes */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["ListedSandbox"][];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
/** @description Create a sandbox from the template */
post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["NewSandbox"];
};
};
responses: {
/** @description The sandbox was created successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["Sandbox"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get a sandbox by id */
get: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the sandbox */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SandboxDetail"];
};
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
/** @description Kill a sandbox */
delete: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sandbox was killed successfully */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/connect": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. */
post: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["ConnectSandbox"];
};
};
responses: {
/** @description The sandbox was already running */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["Sandbox"];
};
};
/** @description The sandbox was resumed successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["Sandbox"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get sandbox logs. Use /v2/sandboxes/{sandboxID}/logs instead.
*/
get: {
parameters: {
query?: {
/** @description Maximum number of logs that should be returned */
limit?: number;
/** @description Starting timestamp of the logs that should be returned in milliseconds */
start?: number;
};
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the sandbox logs */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SandboxLogs"];
};
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get sandbox metrics */
get: {
parameters: {
query?: {
end?: number;
/** @description Unix timestamp for the start of the interval, in seconds, for which the metrics */
start?: number;
};
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the sandbox metrics */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SandboxMetric"][];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/pause": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Pause the sandbox */
post: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sandbox was paused successfully and can be resumed */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
409: components$1["responses"]["409"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/refreshes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Refresh the sandbox extending its time to live */
post: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
/** @description Duration for which the sandbox should be kept alive in seconds */
duration?: number;
};
};
};
responses: {
/** @description Successfully refreshed the sandbox */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/resume": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @deprecated
* @description Resume the sandbox
*/
post: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["ResumedSandbox"];
};
};
responses: {
/** @description The sandbox was resumed successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["Sandbox"];
};
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
409: components$1["responses"]["409"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/snapshots": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Create a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime. */
post: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Optional name for the snapshot template. If a snapshot template with this name already exists, a new build will be assigned to the existing template instead of creating a new one. */
name?: string;
};
};
};
responses: {
/** @description Snapshot created successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SnapshotInfo"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/{sandboxID}/timeout": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Set the timeout for the sandbox. The sandbox will expire x seconds from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the starting point to measure the timeout duration. */
post: {
parameters: {
query?: never;
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": {
/**
* Format: int32
* @description Timeout in seconds from the current time after which the sandbox should expire
*/
timeout: number;
};
};
};
responses: {
/** @description Successfully set the sandbox timeout */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sandboxes/metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List metrics for given sandboxes */
get: {
parameters: {
query: {
/** @description Comma-separated list of sandbox IDs to get metrics for */
sandbox_ids: string[];
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned all running sandboxes with metrics */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SandboxesWithMetrics"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/snapshots": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all snapshots for the team */
get: {
parameters: {
query?: {
/** @description Maximum number of items to return per page */
limit?: components$1["parameters"]["paginationLimit"];
/** @description Cursor to start the list from */
nextToken?: components$1["parameters"]["paginationNextToken"];
sandboxID?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned snapshots */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SnapshotInfo"][];
};
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/teams": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all teams */
get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned all teams */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["Team"][];
};
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/teams/{teamID}/metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get metrics for the team */
get: {
parameters: {
query?: {
end?: number;
/** @description Unix timestamp for the start of the interval, in seconds, for which the metrics */
start?: number;
};
header?: never;
path: {
teamID: components$1["parameters"]["teamID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the team metrics */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TeamMetric"][];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
403: components$1["responses"]["403"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/teams/{teamID}/metrics/max": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get the maximum metrics for the team in the given interval */
get: {
parameters: {
query: {
end?: number;
/** @description Metric to retrieve the maximum value for */
metric: "concurrent_sandboxes" | "sandbox_start_rate";
/** @description Unix timestamp for the start of the interval, in seconds, for which the metrics */
start?: number;
};
header?: never;
path: {
teamID: components$1["parameters"]["teamID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the team metrics */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["MaxTeamMetric"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
403: components$1["responses"]["403"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all templates */
get: {
parameters: {
query?: {
teamID?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned all templates */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["Template"][];
};
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
/**
* @deprecated
* @description Create a new template
*/
post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["TemplateBuildRequest"];
};
};
responses: {
/** @description The build was accepted */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateLegacy"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/{templateID}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all builds for a template */
get: {
parameters: {
query?: {
/** @description Maximum number of items to return per page */
limit?: components$1["parameters"]["paginationLimit"];
/** @description Cursor to start the list from */
nextToken?: components$1["parameters"]["paginationNextToken"];
};
header?: never;
path: {
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the template with its builds */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateWithBuilds"];
};
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
/**
* @deprecated
* @description Rebuild an template
*/
post: {
parameters: {
query?: never;
header?: never;
path: {
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["TemplateBuildRequest"];
};
};
responses: {
/** @description The build was accepted */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateLegacy"];
};
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
/** @description Delete a template */
delete: {
parameters: {
query?: never;
header?: never;
path: {
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The template was deleted successfully */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
options?: never;
head?: never;
/**
* @deprecated
* @description Update template
*/
patch: {
parameters: {
query?: never;
header?: never;
path: {
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["TemplateUpdateRequest"];
};
};
responses: {
/** @description The template was updated successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
trace?: never;
};
"/templates/{templateID}/builds/{buildID}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @deprecated
* @description Start the build
*/
post: {
parameters: {
query?: never;
header?: never;
path: {
buildID: components$1["parameters"]["buildID"];
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The build has started */
202: {
headers: {
[name: string]: unknown;
};
content?: never;
};
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/{templateID}/builds/{buildID}/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get template build logs */
get: {
parameters: {
query?: {
/** @description Starting timestamp of the logs that should be returned in milliseconds */
cursor?: number;
direction?: components$1["schemas"]["LogsDirection"];
level?: components$1["schemas"]["LogLevel"];
/** @description Maximum number of logs that should be returned */
limit?: number;
/** @description Source of the logs that should be returned from */
source?: components$1["schemas"]["LogsSource"];
};
header?: never;
path: {
buildID: components$1["parameters"]["buildID"];
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the template build logs */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateBuildLogsResponse"];
};
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/{templateID}/builds/{buildID}/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get template build info */
get: {
parameters: {
query?: {
level?: components$1["schemas"]["LogLevel"];
/** @description Maximum number of logs that should be returned */
limit?: number;
/** @description Index of the starting build log that should be returned with the template */
logsOffset?: number;
};
header?: never;
path: {
buildID: components$1["parameters"]["buildID"];
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the template */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateBuildInfo"];
};
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/{templateID}/files/{hash}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get an upload link for a tar file containing build layer files */
get: {
parameters: {
query?: never;
header?: never;
path: {
hash: string;
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The upload link where to upload the tar file */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateBuildFileUpload"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/{templateID}/tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all tags for a template */
get: {
parameters: {
query?: never;
header?: never;
path: {
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the template tags */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateTag"][];
};
};
401: components$1["responses"]["401"];
403: components$1["responses"]["403"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/aliases/{alias}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Check if template with given alias exists */
get: {
parameters: {
query?: never;
header?: never;
path: {
alias: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully queried template by alias */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateAliasResponse"];
};
};
400: components$1["responses"]["400"];
403: components$1["responses"]["403"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Assign tag(s) to a template build */
post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["AssignTemplateTagsRequest"];
};
};
responses: {
/** @description Tag assigned successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["AssignedTemplateTags"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
/** @description Delete multiple tags from templates */
delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["DeleteTemplateTagsRequest"];
};
};
responses: {
/** @description Tags deleted successfully */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/sandboxes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description List all sandboxes */
get: {
parameters: {
query?: {
/** @description Maximum number of items to return per page */
limit?: components$1["parameters"]["paginationLimit"];
/** @description Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded. */
metadata?: string;
/** @description Cursor to start the list from */
nextToken?: components$1["parameters"]["paginationNextToken"];
/** @description Filter sandboxes by one or more states */
state?: components$1["schemas"]["SandboxState"][];
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned all running sandboxes */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["ListedSandbox"][];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/sandboxes/{sandboxID}/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get sandbox logs */
get: {
parameters: {
query?: {
/** @description Starting timestamp of the logs that should be returned in milliseconds */
cursor?: number;
/** @description Direction of the logs that should be returned */
direction?: components$1["schemas"]["LogsDirection"];
/** @description Minimum log level to return. Logs below this level are excluded */
level?: components$1["schemas"]["LogLevel"];
/** @description Maximum number of logs that should be returned */
limit?: number;
/** @description Case-sensitive substring match on log message content */
search?: string;
};
header?: never;
path: {
sandboxID: components$1["parameters"]["sandboxID"];
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully returned the sandbox logs */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["SandboxLogsV2Response"];
};
};
401: components$1["responses"]["401"];
404: components$1["responses"]["404"];
500: components$1["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @deprecated
* @description Create a new template
*/
post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["TemplateBuildRequestV2"];
};
};
responses: {
/** @description The build was requested successfully */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateLegacy"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/templates/{templateID}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** @description Update template */
patch: {
parameters: {
query?: never;
header?: never;
path: {
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["TemplateUpdateRequest"];
};
};
responses: {
/** @description The template was updated successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components$1["schemas"]["TemplateUpdateResponse"];
};
};
400: components$1["responses"]["400"];
401: components$1["responses"]["401"];
500: components$1["responses"]["500"];
};
};
trace?: never;
};
"/v2/templates/{templateID}/builds/{buildID}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Start the build */
post: {
parameters: {
query?: never;
header?: never;
path: {
buildID: components$1["parameters"]["buildID"];
templateID: components$1["parameters"]["templateID"];
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components$1["schemas"]["TemplateBuildStartV2"];
};
};
responses: {
/** @description The build