Update a Project
patch
/api/v2/projects/{id}/
Make a PUT or PATCH request to this resource to update this project. The following fields may be modified:
name
: Name of this project. (string, required)description
: Optional description of this project. (string, default=""
)local_path
: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string, default=""
)scm_type
: Specifies the source control system used to store the project. (choice)""
: Manual (default)git
: Gitsvn
: Subversioninsights
: Red Hat Insightsarchive
: Remote Archive
scm_url
: The location where the project is stored. (string, default=""
)scm_branch
: Specific branch, tag or commit to checkout. (string, default=""
)scm_refspec
: For git projects, an additional refspec to fetch. (string, default=""
)scm_clean
: Discard any local changes before syncing the project. (boolean, default=False
)scm_track_submodules
: Track submodules latest commits on defined branch. (boolean, default=False
)scm_delete_on_update
: Delete the project before syncing. (boolean, default=False
)credential
: (id, default=``)-
timeout
: The amount of time (in seconds) to run before the task is canceled. (integer, default=0
) -
organization
: The organization used to determine access to this template. (id, default=``) scm_update_on_launch
: Update the project when a job is launched that uses the project. (boolean, default=False
)scm_update_cache_timeout
: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer, default=0
)-
allow_override
: Allow changing the SCM branch or revision in a job template that uses this project. (boolean, default=False
) -
default_environment
: The default execution environment for jobs run using this project. (id, default=``) signature_validation_credential
: An optional credential used for validating files in the project against unexpected changes. (id, default=``)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : Project
Type:
Show Source
object
-
allow_override:
boolean
Title:
Allow override
Allow changing the SCM branch or revision in a job template that uses this project. -
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
-
custom_virtualenv:
string
Title:
Custom virtualenv
Read Only:true
Minimum Length:1
Local absolute file path containing a custom Python virtualenv to use -
default_environment:
integer
Title:
Default environment
The default execution environment for jobs run using this project. -
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
Read Only:true
-
last_update_failed:
boolean
Title:
Last update failed
Read Only:true
-
last_updated:
string(date-time)
Title:
Last updated
Read Only:true
-
local_path:
string
Title:
Local path
Maximum Length:1024
Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
-
organization:
integer
Title:
Organization
The organization used to determine access to this template. - related: string
-
scm_branch:
string
Title:
SCM Branch
Maximum Length:256
Specific branch, tag or commit to checkout. -
scm_clean:
boolean
Title:
Scm clean
Discard any local changes before syncing the project. -
scm_delete_on_update:
boolean
Title:
Scm delete on update
Delete the project before syncing. -
scm_refspec:
string
Title:
SCM refspec
Maximum Length:1024
For git projects, an additional refspec to fetch. -
scm_revision:
string
Title:
SCM Revision
Read Only:true
Minimum Length:1
The last revision fetched by a project update -
scm_track_submodules:
boolean
Title:
Scm track submodules
Track submodules latest commits on defined branch. -
scm_type:
string
Title:
SCM Type
Allowed Values:[ "", "git", "svn", "insights", "archive" ]
Specifies the source control system used to store the project. -
scm_update_cache_timeout:
integer
Title:
Scm update cache timeout
Minimum Value:0
The number of seconds after the last project update ran that a new project update will be launched as a job dependency. -
scm_update_on_launch:
boolean
Title:
Scm update on launch
Update the project when a job is launched that uses the project. -
scm_url:
string
Title:
SCM URL
Maximum Length:1024
The location where the project is stored. -
signature_validation_credential:
integer
Title:
Signature validation credential
An optional credential used for validating files in the project against unexpected changes. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
timeout:
integer
Title:
Timeout
The amount of time (in seconds) to run before the task is canceled. -
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Response
Supported Media Types
- application/json
200 Response
Root Schema : Project
Type:
Show Source
object
-
allow_override:
boolean
Title:
Allow override
Allow changing the SCM branch or revision in a job template that uses this project. -
created:
string
Title:
Created
Read Only:true
-
credential:
integer
Title:
Credential
-
custom_virtualenv:
string
Title:
Custom virtualenv
Read Only:true
Minimum Length:1
Local absolute file path containing a custom Python virtualenv to use -
default_environment:
integer
Title:
Default environment
The default execution environment for jobs run using this project. -
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
last_job_failed:
boolean
Title:
Last job failed
Read Only:true
-
last_job_run:
string(date-time)
Title:
Last job run
Read Only:true
-
last_update_failed:
boolean
Title:
Last update failed
Read Only:true
-
last_updated:
string(date-time)
Title:
Last updated
Read Only:true
-
local_path:
string
Title:
Local path
Maximum Length:1024
Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
next_job_run:
string(date-time)
Title:
Next job run
Read Only:true
-
organization:
integer
Title:
Organization
The organization used to determine access to this template. - related: string
-
scm_branch:
string
Title:
SCM Branch
Maximum Length:256
Specific branch, tag or commit to checkout. -
scm_clean:
boolean
Title:
Scm clean
Discard any local changes before syncing the project. -
scm_delete_on_update:
boolean
Title:
Scm delete on update
Delete the project before syncing. -
scm_refspec:
string
Title:
SCM refspec
Maximum Length:1024
For git projects, an additional refspec to fetch. -
scm_revision:
string
Title:
SCM Revision
Read Only:true
Minimum Length:1
The last revision fetched by a project update -
scm_track_submodules:
boolean
Title:
Scm track submodules
Track submodules latest commits on defined branch. -
scm_type:
string
Title:
SCM Type
Allowed Values:[ "", "git", "svn", "insights", "archive" ]
Specifies the source control system used to store the project. -
scm_update_cache_timeout:
integer
Title:
Scm update cache timeout
Minimum Value:0
The number of seconds after the last project update ran that a new project update will be launched as a job dependency. -
scm_update_on_launch:
boolean
Title:
Scm update on launch
Update the project when a job is launched that uses the project. -
scm_url:
string
Title:
SCM URL
Maximum Length:1024
The location where the project is stored. -
signature_validation_credential:
integer
Title:
Signature validation credential
An optional credential used for validating files in the project against unexpected changes. -
status:
string
Title:
Status
Read Only:true
Allowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing" ]
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
timeout:
integer
Title:
Timeout
The amount of time (in seconds) to run before the task is canceled. -
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true