Skip to content

Modify



POST /api/v1/channel/{channel_uuid}/modify

Overview

Route Parameters

Parameter Name Type Required Description
channel_uuid string Y Channel UUID

Body Request Parameters

Parameter Name Type Required Description
name string Channel name
Example: Channel 1
Allow empty: False
Max length: 256
description string Channel description
Example: CUSTOM
Allow empty: False
Allow empty string: True
Max length: 256
notifyTarget array Notification target UUID list
Example: []
Allow empty: False
notifyUpgradeCfg json Rule configuration
Allow empty: False
notifyUpgradeCfg.triggerTime integer Y How long to trigger upgrade notification, unit s
Example: simpleCheck
Allow empty: False
notifyUpgradeCfg.notifyTarget array Y Upgrade notification target UUID list
Example: []
Allow empty: False

Additional Parameter Notes

Request Example

curl 'https://openapi.guance.com/api/v1/channel/chan_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"description":"dasdgahjsdgashjgdhajsgdasjhgdhjasgdajhsgzxvchv @sadddddd","notifyTarget":["notify_xxxx32"]}' \
--compressed

Response

{
    "code": 200,
    "content": {
        "createAt": 1680257540,
        "creator": "acnt_xxxx32",
        "deleteAt": 1681968404,
        "description": "dasdgahjsdgashjgdhajsgdasjhgdhjasgdajhsgzxvchv @sadddddd",
        "id": 33,
        "name": "default",
        "notifyTarget": [
            "notify_xxxx32"
        ],
        "status": 0,
        "updateAt": 1686397319.9216194,
        "updator": "acnt_xxxx32",
        "uuid": "chan_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "14871204483417928076"
}

Feedback

Is this page helpful? ×