Projects

Projects

Projects

Create a new project

client.projects.create(ProjectCreateParamsbody, RequestOptionsoptions?): config_repostringdisplay_nameunionobject"project"orgstringslugstringtargetsarrayProject

post/v0/projects

List projects in an organization, from oldest to newest

client.projects.list(ProjectListParamsquery?, RequestOptionsoptions?): Page<config_repostringdisplay_nameunionobject"project"orgstringslugstringtargetsarrayProject>

get/v0/projects

Retrieve a project by name

client.projects.retrieve(ProjectRetrieveParamsparams?, RequestOptionsoptions?): config_repostringdisplay_nameunionobject"project"orgstringslugstringtargetsarrayProject

get/v0/projects/{project}

Update a project's properties

client.projects.update(ProjectUpdateParamsparams?, RequestOptionsoptions?): config_repostringdisplay_nameunionobject"project"orgstringslugstringtargetsarrayProject

patch/v0/projects/{project}

Project

Project

ShowShow

config_repostring

display_nameunion

string | null

object"project"

Hide ParametersShow Parameters

"project"

orgstring

slugstring

targetsarray

Array<Target>

Hide ParametersShow Parameters

"node"

"typescript"

"python"

"go"

"java"

"kotlin"

"ruby"

"terraform"

"cli"

"php"

"csharp"

ProjectsBranches

Create a new branch for a project

client.projects.branches.create(BranchCreateParamsparams, RequestOptionsoptions?): branchstringconfig_commitCommitlatest_buildunionobject"project_branch"orgstringprojectstringProjectBranch

post/v0/projects/{project}/branches

Delete a project branch

client.projects.branches.delete(stringbranch, BranchDeleteParamsparams?, RequestOptionsoptions?): BranchDeleteResponse

delete/v0/projects/{project}/branches/{branch}

List project branches

client.projects.branches.list(BranchListParamsparams?, RequestOptionsoptions?): Page<branchstringconfig_commitCommitlatest_build_idstringobject"project_branch"orgstringprojectstringBranchListResponse>

get/v0/projects/{project}/branches

Retrieve a project branch

client.projects.branches.retrieve(stringbranch, BranchRetrieveParamsparams?, RequestOptionsoptions?): branchstringconfig_commitCommitlatest_buildunionobject"project_branch"orgstringprojectstringProjectBranch

get/v0/projects/{project}/branches/{branch}

Project Branch

ProjectBranch

ShowShow

branchstring

config_commitrepoReposhastringCommit

latest_buildunion

idstringconfig_commitstringcreated_atstringdocumented_specunionobject"build"orgstringprojectstringtargetsTargetsupdated_atstringBuildObject | null

object"project_branch"

Hide ParametersShow Parameters

"project_branch"

orgstring

projectstring

ProjectsConfigs

Generate configuration suggestions based on an OpenAPI spec

client.projects.configs.guess(ConfigGuessParamsparams, RequestOptionsoptions?): contentstringConfigGuessResponse

post/v0/projects/{project}/configs/guess

Retrieve configuration files for a project

client.projects.configs.retrieve(ConfigRetrieveParamsparams?, RequestOptionsoptions?): contentstringConfigRetrieveResponse

get/v0/projects/{project}/configs