Updated on 2024-12-02 GMT+08:00

Updating Trigger Settings

Function

Update the status of a trigger.

URI

PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/triggers/{trigger}

Table 1 describes the parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

namespace

Yes

String

Organization name

repository

Yes

String

Image repository name

trigger

Yes

String

Trigger name

Request

  • Request parameters
    Table 2 Request header parameters

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Message body type (format). The value can be application/json or charset=utf-8 application/json.

    The default value is application/json.

    X-Auth-Token

    Yes

    String

    User token.

    The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

    Table 3 Request body parameters

    Parameter

    Mandatory

    Type

    Description

    enable

    Yes

    String

    Whether to enable the trigger. The value can be true, which indicates enabling the trigger, and false, which indicates disabling the trigger.

  • Example request
    PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/triggers/test
    
    {
        "enable": "true"
    }

Response

  • Response parameters

    N/A

  • Example response

    N/A

Status Code

Status Code

Description

201

Request successful.

400

Request error.

401

Authentication failed.

404

The organization does not exist.

500

Failed to complete the request because of an internal service error.

Error Codes

For details, see Error Codes.