Retrieve a Project

get

/api/v2/projects/{id}/

Make GET request to this resource to retrieve a single project record containing the following fields:

  • id: Database ID for this project. (integer)
  • type: Data type for this project. (choice)
  • url: URL for this project. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • created: Timestamp when this project was created. (datetime)
  • modified: Timestamp when this project was last modified. (datetime)
  • name: Name of this project. (string)
  • description: Optional description of this project. (string)
  • local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
  • scm_type: Specifies the source control system used to store the project. (choice)
    • "": Manual
    • git: Git
    • svn: Subversion
    • insights: Red Hat Insights
    • archive: Remote Archive
  • scm_url: The location where the project is stored. (string)
  • scm_branch: Specific branch, tag or commit to checkout. (string)
  • scm_refspec: For git projects, an additional refspec to fetch. (string)
  • scm_clean: Discard any local changes before syncing the project. (boolean)
  • scm_track_submodules: Track submodules latest commits on defined branch. (boolean)
  • scm_delete_on_update: Delete the project before syncing. (boolean)
  • credential: (id)
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
  • scm_revision: The last revision fetched by a project update (string)
  • last_job_run: (datetime)
  • last_job_failed: (boolean)
  • next_job_run: (datetime)
  • status: (choice)
    • new: New
    • pending: Pending
    • waiting: Waiting
    • running: Running
    • successful: Successful
    • failed: Failed
    • error: Error
    • canceled: Canceled
    • never updated: Never Updated
    • ok: OK
    • missing: Missing
  • organization: The organization used to determine access to this template. (id)
  • scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
  • 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)
  • allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
  • default_environment: The default execution environment for jobs run using this project. (id)
  • signature_validation_credential: An optional credential used for validating files in the project against unexpected changes. (id)
  • last_update_failed: (boolean)
  • last_updated: (datetime)

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : Project
Type: object
Show Source
Back to Top