Skip to content

api.md

Latest commit

 

History

History
341 lines (249 loc) · 23.6 KB

api.md

File metadata and controls

341 lines (249 loc) · 23.6 KB
Raw

Shared

Types:

Accounts

Types:

Methods:

  • client.accounts.me() -> AccountView

Agents

Types:

Methods:

  • client.agents.create({ ...params }) -> AgentView
  • client.agents.retrieve(id) -> AgentView
  • client.agents.list({ ...params }) -> AgentViewsAgentsCursorIDPage
  • client.agents.delete(id) -> unknown
  • client.agents.devboxCounts() -> AgentDevboxCountsView
  • client.agents.listPublic({ ...params }) -> AgentViewsAgentsCursorIDPage

Axons

Types:

Methods:

  • client.axons.create({ ...params }) -> AxonView
  • client.axons.retrieve(id) -> AxonView
  • client.axons.update(id, { ...params }) -> AxonView
  • client.axons.list({ ...params }) -> AxonViewsAxonsCursorIDPage
  • client.axons.delete(id) -> unknown
  • client.axons.publish(id, { ...params }) -> PublishResultView
  • client.axons.subscribeSse(id, { ...params }) -> AxonEventView

Events

Types:

Methods:

  • client.axons.events.list(id, { ...params }) -> AxonEventListView

Sql

Types:

Methods:

  • client.axons.sql.batch(id, { ...params }) -> SqlBatchResultView
  • client.axons.sql.query(id, { ...params }) -> SqlQueryResultView

Blueprints

Types:

Methods:

  • client.blueprints.create({ ...params }) -> BlueprintView
  • client.blueprints.retrieve(id) -> BlueprintView
  • client.blueprints.list({ ...params }) -> BlueprintViewsBlueprintsCursorIDPage
  • client.blueprints.delete(id) -> unknown
  • client.blueprints.listPublic({ ...params }) -> BlueprintViewsBlueprintsCursorIDPage
  • client.blueprints.logs(id) -> BlueprintBuildLogsListView
  • client.blueprints.preview({ ...params }) -> BlueprintPreviewView

Devboxes

Types:

Methods:

  • client.devboxes.create({ ...params }) -> DevboxView
  • client.devboxes.retrieve(id) -> DevboxView
  • client.devboxes.update(id, { ...params }) -> DevboxView
  • client.devboxes.list({ ...params }) -> DevboxViewsDevboxesCursorIDPage
  • client.devboxes.createGatewayToken(id, { ...params }) -> GatewayTokenView
  • client.devboxes.createMcpToken(id, { ...params }) -> McpTokenView
  • client.devboxes.createPtyTunnel(id) -> PtyTunnelView
  • client.devboxes.createSSHKey(id) -> DevboxCreateSSHKeyResponse
  • client.devboxes.deleteDiskSnapshot(id) -> unknown
  • client.devboxes.downloadFile(id, { ...params }) -> Response
  • client.devboxes.enableTunnel(id, { ...params }) -> TunnelView
  • client.devboxes.execute(id, { ...params }) -> DevboxAsyncExecutionDetailView
  • client.devboxes.executeAsync(id, { ...params }) -> DevboxAsyncExecutionDetailView
  • client.devboxes.executeSync(id, { ...params }) -> DevboxExecutionDetailView
  • client.devboxes.keepAlive(id) -> unknown
  • client.devboxes.listDiskSnapshots({ ...params }) -> DevboxSnapshotViewsDiskSnapshotsCursorIDPage
  • client.devboxes.readFileContents(id, { ...params }) -> string
  • client.devboxes.removeTunnel(id) -> unknown
  • client.devboxes.resume(id) -> DevboxView
  • client.devboxes.retrieveResourceUsage(id) -> DevboxResourceUsageView
  • client.devboxes.shutdown(id, { ...params }) -> DevboxView
  • client.devboxes.snapshotDisk(id, { ...params }) -> DevboxSnapshotView
  • client.devboxes.snapshotDiskAsync(id, { ...params }) -> DevboxSnapshotView
  • client.devboxes.suspend(id) -> DevboxView
  • client.devboxes.uploadFile(id, { ...params }) -> unknown
  • client.devboxes.waitForCommand(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView
  • client.devboxes.watchEvictions() -> DevboxEvictionEventView
  • client.devboxes.writeFileContents(id, { ...params }) -> DevboxExecutionDetailView

DiskSnapshots

Types:

Methods:

  • client.devboxes.diskSnapshots.update(id, { ...params }) -> DevboxSnapshotView
  • client.devboxes.diskSnapshots.list({ ...params }) -> DevboxSnapshotViewsDiskSnapshotsCursorIDPage
  • client.devboxes.diskSnapshots.delete(id) -> unknown
  • client.devboxes.diskSnapshots.queryStatus(id) -> DevboxSnapshotAsyncStatusView

Logs

Types:

Methods:

  • client.devboxes.logs.list(id, { ...params }) -> DevboxLogsListView

Executions

Types:

Methods:

  • client.devboxes.executions.retrieve(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView
  • client.devboxes.executions.executeAsync(id, { ...params }) -> DevboxAsyncExecutionDetailView
  • client.devboxes.executions.executeSync(id, { ...params }) -> DevboxExecutionDetailView
  • client.devboxes.executions.kill(devboxId, executionId, { ...params }) -> DevboxAsyncExecutionDetailView
  • client.devboxes.executions.sendStdIn(devboxId, executionId, { ...params }) -> DevboxSendStdInResult
  • client.devboxes.executions.streamStderrUpdates(devboxId, executionId, { ...params }) -> ExecutionUpdateChunk
  • client.devboxes.executions.streamStdoutUpdates(devboxId, executionId, { ...params }) -> ExecutionUpdateChunk

Pty

Types:

Methods:

  • client.pty.connect(sessionName, { ...params }) -> PtyConnectView
  • client.pty.control(sessionName, { ...params }) -> PtyControlResultView

Objects

Types:

Methods:

  • client.objects.create({ ...params }) -> ObjectView
  • client.objects.retrieve(id) -> ObjectView
  • client.objects.list({ ...params }) -> ObjectViewsObjectsCursorIDPage
  • client.objects.delete(id) -> ObjectView
  • client.objects.complete(id) -> ObjectView
  • client.objects.download(id, { ...params }) -> ObjectDownloadURLView
  • client.objects.listPublic({ ...params }) -> ObjectViewsObjectsCursorIDPage

Secrets

Types:

Methods:

  • client.secrets.create({ ...params }) -> SecretView
  • client.secrets.retrieve(name) -> SecretView
  • client.secrets.update(name, { ...params }) -> SecretView
  • client.secrets.list({ ...params }) -> SecretListView
  • client.secrets.delete(name) -> SecretView

NetworkPolicies

Types:

Methods:

  • client.networkPolicies.create({ ...params }) -> NetworkPolicyView
  • client.networkPolicies.retrieve(id) -> NetworkPolicyView
  • client.networkPolicies.update(id, { ...params }) -> NetworkPolicyView
  • client.networkPolicies.list({ ...params }) -> NetworkPolicyViewsNetworkPoliciesCursorIDPage
  • client.networkPolicies.delete(id) -> NetworkPolicyView

GatewayConfigs

Types:

Methods:

  • client.gatewayConfigs.create({ ...params }) -> GatewayConfigView
  • client.gatewayConfigs.retrieve(id) -> GatewayConfigView
  • client.gatewayConfigs.update(id, { ...params }) -> GatewayConfigView
  • client.gatewayConfigs.list({ ...params }) -> GatewayConfigViewsGatewayConfigsCursorIDPage
  • client.gatewayConfigs.delete(id) -> GatewayConfigView

McpConfigs

Types:

Methods:

  • client.mcpConfigs.create({ ...params }) -> McpConfigView
  • client.mcpConfigs.retrieve(id) -> McpConfigView
  • client.mcpConfigs.update(id, { ...params }) -> McpConfigView
  • client.mcpConfigs.list({ ...params }) -> McpConfigViewsMcpConfigsCursorIDPage
  • client.mcpConfigs.delete(id) -> McpConfigView

Apikeys

Types:

Methods:

  • client.apikeys.create({ ...params }) -> APIKeyCreatedView

RestrictedKeys

Types:

Methods:

  • client.restrictedKeys.create({ ...params }) -> RestrictedKeyCreatedView