ANansible
projects

PATCH /projects/{id}/

Changed on

Partial update of a project

Request

  • Base URL
    /api/eda/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/eda/v1/projects/{id}/
  • Auth
    • API key in cookie sessionid
    • or HTTP basic
    • or HTTP bearer
    • or API key in header X-DAB-JW-TOKEN

Path parameters

idinteger required

A unique integer value identifying this project.

Request body

namestring

Name of the project

descriptionstring nullable

Description of the project

organization_idinteger
eda_credential_idinteger nullable

EdaCredential id of the project

signature_validation_credential_idinteger nullable

ID of an optional credential used for validating files in the project against unexpected changes

scm_branchstring nullable

Specific branch, tag or commit to checkout.

scm_refspecstring nullable

For git projects, an additional refspec to fetch.

verify_sslboolean

Indicates if SSL verification is enabled

proxystring nullable

Proxy server for http or https connection

Response

Update successful. Return an updated project.

namestring required
descriptionstring
organization_idinteger nullable required
eda_credential_idinteger nullable
signature_validation_credential_idinteger nullable required
scm_branchstring
scm_refspecstring
verify_sslboolean
proxystring required
idinteger required
urlstring required
scm_type'git' required
  • git - Git
git_hashstring required
import_state'pending' | 'running' | 'failed' | 'completed' required
  • pending - Pending
  • running - Running
  • failed - Failed
  • completed - Completed
import_errorstring nullable required
created_atstring date-time required
modified_atstring date-time required

Changes

  • c04fc5f09692Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

  • cbf68ddd9760Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security EDAJWTAuthentication was added to the API

    • info

      the endpoint scheme security jwtAuth was added to the API

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status