Skip to content
  • Auto
  • Light
  • Dark

Projects

Projects

Projects

Create a new project
projects.create(ProjectCreateParams**kwargs) -> config_repostrdisplay_namestrobjectliteralorgstrslugstrtargetslistProject
post/v0/projects
List projects in an organization, from oldest to newest
projects.list(ProjectListParams**kwargs) -> SyncPage[config_repostrdisplay_namestrobjectliteralorgstrslugstrtargetslistProject]
get/v0/projects
Retrieve a project by name
projects.retrieve(ProjectRetrieveParams**kwargs) -> config_repostrdisplay_namestrobjectliteralorgstrslugstrtargetslistProject
get/v0/projects/{project}
Update a project's properties
projects.update(ProjectUpdateParams**kwargs) -> config_repostrdisplay_namestrobjectliteralorgstrslugstrtargetslistProject
patch/v0/projects/{project}
Project
Projectclass
ShowShow
config_repostr
display_namestr
objectliteral
Literal["project"]
Hide ParametersShow Parameters
"project"
orgstr
slugstr
targetslist
List[Target]
Hide ParametersShow Parameters
"node"
"typescript"
"python"
"go"
"java"
"kotlin"
"ruby"
"terraform"
"cli"
"php"
"csharp"

ProjectsBranches

Create a new branch for a project
projects.branches.create(BranchCreateParams**kwargs) -> branchstrconfig_commitCommitlatest_buildBuildObjectobjectliteralorgstrprojectstrProjectBranch
post/v0/projects/{project}/branches
Delete a project branch
projects.branches.delete(strbranch, BranchDeleteParams**kwargs) -> object
delete/v0/projects/{project}/branches/{branch}
List project branches
projects.branches.list(BranchListParams**kwargs) -> SyncPage[branchstrconfig_commitCommitlatest_build_idstrobjectliteralorgstrprojectstrBranchListResponse]
get/v0/projects/{project}/branches
Retrieve a project branch
projects.branches.retrieve(strbranch, BranchRetrieveParams**kwargs) -> branchstrconfig_commitCommitlatest_buildBuildObjectobjectliteralorgstrprojectstrProjectBranch
get/v0/projects/{project}/branches/{branch}
Project Branch
ProjectBranchclass
ShowShow
branchstr
config_commitrepoReposhastrCommit
latest_buildBuildObject
objectliteral
Literal["project_branch"]
Hide ParametersShow Parameters
"project_branch"
orgstr
projectstr

ProjectsConfigs

Generate configuration suggestions based on an OpenAPI spec
projects.configs.guess(ConfigGuessParams**kwargs) -> contentstrConfigGuessResponse
post/v0/projects/{project}/configs/guess
Retrieve configuration files for a project
projects.configs.retrieve(ConfigRetrieveParams**kwargs) -> contentstrConfigRetrieveResponse
get/v0/projects/{project}/configs