Projects

Get a Project by ID or slug.

get/projects/{projectId}/{unusedGitRef}

Path parameters

projectIdstring required

ID of the Project to return

unusedGitRefstring required

Response

The requested Project.

AllowIgnoreChannelRulesboolean

AutoCreateReleaseboolean

ClonedFromProjectIdstring

CombineHealthAndSyncStatusInDashboardLiveStatusboolean

DefaultGuidedFailureMode'EnvironmentDefault' | 'Off' | 'On'

DefaultPowerShellEditionstring

DefaultToSkipIfAlreadyInstalledboolean

DeploymentChangesTemplatestring

DeploymentProcessIdstring

DeprovisioningRunbookIdstring

Descriptionstring

DiscreteChannelReleaseboolean

Treats releases of different channels to the same environment as a seperate deployment dimension. 'False' indicates a "hotfix"-style usage of channels (single release active per environment ignoring channels), whereas True indicates "microservice"-style usage (single release per environment per channel)

ExecuteDeploymentsOnEventBasedPipelineboolean

ForcePackageDownloadboolean

Idstring

Gets or sets a unique identifier for this resource.

IncludedLibraryVariableSetIdsstring[]

Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.

IsBadgesEnabledboolean

IsDisabledboolean

IsVersionControlledboolean

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LifecycleIdstring

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring

ProjectGroupIdstring

ProjectTagsstring[]

List of tags assigned to this project

ProvisioningRunbookIdstring

ReleaseNotesTemplatestring

Slugstring

SpaceIdstring

TenantedDeploymentMode'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'

VariableSetIdstring

Example response

{
  "AutoDeployReleaseOverrides": [
    {
      "TenantId": "Tenants-1"
    }
  ],
  "ClonedFromProjectId": "Projects-1",
  "DeprovisioningRunbookId": "Runbooks-1",
  "ProvisioningRunbookId": "Runbooks-1",
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this endpoint across all 7 revisions of this API.