Create a Project for an Organization
post
/api/v2/organizations/{id}/projects/
Make a POST request to this resource with the following project fields to create a new project associated with this organization.
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
: Githg
: Mercurialsvn
: 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_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
) -
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
)custom_virtualenv
: Local absolute file path containing a custom Python virtualenv to use (string, default=""
)
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : schema
Type:
Show Source
object
-
allow_override(optional):
boolean
Allow changing the SCM branch or revision in a job template that uses this project.
-
credential(optional):
integer
-
custom_virtualenv(optional):
string
Local absolute file path containing a custom Python virtualenv to use
-
description(optional):
string
-
local_path(optional):
string
Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.
-
name:
string
-
organization(optional):
integer
The organization used to determine access to this template.
-
scm_branch(optional):
string
Specific branch, tag or commit to checkout.
-
scm_clean(optional):
boolean
Discard any local changes before syncing the project.
-
scm_delete_on_update(optional):
boolean
Delete the project before syncing.
-
scm_refspec(optional):
string
For git projects, an additional refspec to fetch.
-
scm_type(optional):
string
Specifies the source control system used to store the project.
-
scm_update_cache_timeout(optional):
integer
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(optional):
boolean
Update the project when a job is launched that uses the project.
-
scm_url(optional):
string
The location where the project is stored.
-
timeout(optional):
integer
The amount of time (in seconds) to run before the task is canceled.