Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

Latest commit

 

History

History
123 lines (99 loc) · 9.83 KB

api.md

File metadata and controls

123 lines (99 loc) · 9.83 KB

Vm

Types:

Methods:

  • client.vm.list() -> VmListResponse
  • client.vm.delete(vmID, { ...params }) -> VmDeleteResponse
  • client.vm.branch(vmOrCommitID, { ...params }) -> NewVmsResponse
  • client.vm.branchByCommit(commitID, { ...params }) -> NewVmsResponse
  • client.vm.branchByTag(tagName, { ...params }) -> NewVmsResponse
  • client.vm.branchByVm(vmID, { ...params }) -> NewVmsResponse
  • client.vm.commit(vmID, { ...params }) -> VmCommitResponse
  • client.vm.createRoot({ ...params }) -> NewVmResponse
  • client.vm.exec(vmID, { ...params }) -> VmExecResponse
  • client.vm.execStream(vmID, { ...params }) -> void
  • client.vm.execStreamAttach(vmID, { ...params }) -> void
  • client.vm.getLogs(vmID, { ...params }) -> VmExecLogResponse
  • client.vm.getMetadata(vmID) -> VmMetadataResponse
  • client.vm.getSSHKey(vmID) -> VmSSHKeyResponse
  • client.vm.resizeDisk(vmID, { ...params }) -> void
  • client.vm.restoreFromCommit({ ...params }) -> NewVmResponse
  • client.vm.status(vmID) -> Vm
  • client.vm.updateState(vmID, { ...params }) -> void

Commits

Types:

Methods:

  • client.commits.update(commitID, { ...params }) -> CommitInfo
  • client.commits.list() -> ListCommitsResponse
  • client.commits.delete(commitID) -> void
  • client.commits.listParents(commitID) -> CommitListParentsResponse
  • client.commits.listPublic() -> ListCommitsResponse

CommitTags

Types:

Methods:

  • client.commitTags.create({ ...params }) -> CreateTagResponse
  • client.commitTags.update(tagName, { ...params }) -> void
  • client.commitTags.list() -> ListTagsResponse
  • client.commitTags.delete(tagName) -> void
  • client.commitTags.get(tagName) -> TagInfo

Repositories

Types:

Methods:

  • client.repositories.create({ ...params }) -> CreateRepositoryResponse
  • client.repositories.list() -> ListRepositoriesResponse
  • client.repositories.delete(repoName) -> void
  • client.repositories.createTag(repoName, { ...params }) -> CreateRepoTagResponse
  • client.repositories.deleteTag(tagName, { ...params }) -> void
  • client.repositories.fork({ ...params }) -> ForkRepositoryResponse
  • client.repositories.get(repoName) -> RepositoryInfo
  • client.repositories.getTag(tagName, { ...params }) -> RepoTagInfo
  • client.repositories.listTags(repoName) -> ListRepoTagsResponse
  • client.repositories.setVisibility(repoName, { ...params }) -> void
  • client.repositories.updateTag(tagName, { ...params }) -> void

PublicRepositories

Types:

Methods:

  • client.publicRepositories.list() -> ListPublicRepositoriesResponse
  • client.publicRepositories.get(repoName, { ...params }) -> PublicRepositoryInfo
  • client.publicRepositories.getTag(tagName, { ...params }) -> RepoTagInfo
  • client.publicRepositories.listTags(repoName, { ...params }) -> ListRepoTagsResponse