Skip to content
  • Auto
  • Light
  • Dark

Projects

Projects

Projects

Create a new project
client.Projects.New(ctx, body) (*ConfigRepostringDisplayNamestringObjectProjectObjectOrgstringSlugstringTargetsarrayProject, error)
post/v0/projects
List projects in an organization, from oldest to newest
client.Projects.List(ctx, query) (*Page[ConfigRepostringDisplayNamestringObjectProjectObjectOrgstringSlugstringTargetsarrayProject], error)
get/v0/projects
Retrieve a project by name
client.Projects.Get(ctx, query) (*ConfigRepostringDisplayNamestringObjectProjectObjectOrgstringSlugstringTargetsarrayProject, error)
get/v0/projects/{project}
Update a project's properties
client.Projects.Update(ctx, params) (*ConfigRepostringDisplayNamestringObjectProjectObjectOrgstringSlugstringTargetsarrayProject, error)
patch/v0/projects/{project}
Project
Projectstruct
ShowShow
ConfigRepostring
DisplayNamestring
ObjectProjectObjectProjectProjectObjectProjectObject
Hide ParametersShow Parameters
ProjectObjectProjectconst
ProjectObjectProjectProjectObjectProjectObject
"project"
Orgstring
Slugstring
Targetsarray
[]TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
Hide ParametersShow Parameters
TargetNodeconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"node"
TargetTypescriptconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"typescript"
TargetPythonconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"python"
TargetGoconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"go"
TargetJavaconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"java"
TargetKotlinconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"kotlin"
TargetRubyconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"ruby"
TargetTerraformconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"terraform"
TargetCliconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"cli"
TargetPhpconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"php"
TargetCsharpconst
TargetNodeTargetTargetTypescriptTargetTargetPythonTargetTargetGoTargetTargetJavaTargetTargetKotlinTargetTargetRubyTargetTargetTerraformTargetTargetCliTargetTargetPhpTargetTargetCsharpTargetTarget
"csharp"

ProjectsBranches

Create a new branch for a project
client.Projects.Branches.New(ctx, params) (*BranchstringConfigCommitCommitLatestBuildBuildObjectObjectProjectBranchObjectOrgstringProjectstringProjectBranch, error)
post/v0/projects/{project}/branches
Delete a project branch
client.Projects.Branches.Delete(ctx, branch, body) (*ProjectBranchDeleteResponse, error)
delete/v0/projects/{project}/branches/{branch}
List project branches
client.Projects.Branches.List(ctx, params) (*Page[BranchstringConfigCommitCommitLatestBuildIDstringObjectstringOrgstringProjectstringProjectBranchListResponse], error)
get/v0/projects/{project}/branches
Retrieve a project branch
client.Projects.Branches.Get(ctx, branch, query) (*BranchstringConfigCommitCommitLatestBuildBuildObjectObjectProjectBranchObjectOrgstringProjectstringProjectBranch, error)
get/v0/projects/{project}/branches/{branch}
Project Branch
ProjectBranchstruct
ShowShow
Branchstring
ConfigCommitRepoCommitRepoShastringCommit
LatestBuildIDstringConfigCommitstringCreatedAtTimeDocumentedSpecBuildObjectDocumentedSpecUnionObjectBuildObjectObjectOrgstringProjectstringTargetsBuildObjectTargetsUpdatedAtTimeBuildObject
ObjectProjectBranchObjectProjectBranchProjectBranchObjectProjectBranchObject
Hide ParametersShow Parameters
ProjectBranchObjectProjectBranchconst
ProjectBranchObjectProjectBranchProjectBranchObjectProjectBranchObject
"project_branch"
Orgstring
Projectstring

ProjectsConfigs

Generate configuration suggestions based on an OpenAPI spec
client.Projects.Configs.Guess(ctx, params) (*ContentstringProjectConfigGuessResponse, error)
post/v0/projects/{project}/configs/guess
Retrieve configuration files for a project
client.Projects.Configs.Get(ctx, params) (*ContentstringProjectConfigGetResponse, error)
get/v0/projects/{project}/configs