Skip to main content

Update application component codenow triggers

PUT 
/applications/:applicationId/components/:applicationComponentId/triggers

Update application component codenow triggers

Request​

Path Parameters

    applicationId stringrequired

    Possible values: non-empty

    applicationComponentId stringrequired

    Possible values: non-empty

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Body

required

    triggers

    object[]

    required


    A list of objects representing all triggers currently defined for this component.

  • Array [

    • event string


    The event that will activate this trigger on every occurrence. The default value is push

    pipeline stringrequired

    Possible values: non-empty


    The pipeline used for building the component. It generally depends on the template (language, build tool, framework) the component is based on.

    enabled boolean


    A boolean flag indicating whether the trigger is active.
    If missing or set to false, the trigger will stay defined in the configuration file, but will not execute.

    branch stringrequired

    Possible values: non-empty


    The git branch(es) associated with the trigger. event occurrences on this branch will execute the trigger.
    You can specify either a single branch name or a glob pattern potentially matching multiple branches.

    applicationPackage

    object


    An object specifying the version to be used for creating a new application package after the component release, if any.
    If no value is provided, no new package will be created upon the release of the component during trigger execution.

    versionPattern string


    The semver pattern used for versioning the application package created after the component release.
    Use pattern with wildcards to specify package version (? latest, + increment, i.e. 1.?.+ will increment patch version for the latest version where major path is 1).

    deployments

    object[]


    A list of objects specifying the deployment of the application package potentially created in the previous step to specific environment(s) and the corresponding configurations to be used.
    An empty or missing list indicates that no deployments will be executed.

  • Array [

    • enabled boolean


    A boolean flag indicating whether the deployment should be executed.
    If missing or set to false, the deployment will stay defined in the configuration file, but will not execute.

    environment stringrequired

    Possible values: non-empty


    The ID of the environment the application should be deployed to.

    configuration stringrequired

    Possible values: non-empty


    Specification of the deployment configuration used for the deployment.
    The two valid values are latest, representing the highest versioned defined configuration, and branch, representing the configuration stored in the branch associated with the trigger.

  • ]

    • type string


    The primary action executed by the trigger. Default value is preview, representing a preview build, the other possible value is release, representing a release build.

    version

    object

    nullable


    Specifies how to determine the next version of the component.
    You must choose either version pattern or a branch pattern. If no version is specified, the patch version of the last major and minor path will be incremented.

    pattern string


    The semver pattern used for versioning the component builds.
    Use pattern with wildcards to specify release version (? latest, + increment, i.e. 1.?.+ will increment patch version for the latest version where major path is 1).

    branchPattern string

    Possible values: non-empty


    The release version will be determined from the branch name following this pattern.
    ${MAJOR}, ${MINOR} can be used as placeholders. i.e release/${MAJOR}.${MINOR} for release/1.5 will creates 1.5.0, 1.5.1, etc builds versions.

  • ]

Responses​

Component triggers were updated

Schema

    status stringrequired

    Possible values: non-empty

Loading...