channels

Search channels

Changed on

Search channel names, remarks, keys, URLs, models and sets with a keyword, combined with optional exact filters

get/api/channels/search

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Query parameters

keywordstring

Search keyword, including remark content

pageinteger

Page number

per_pageinteger

Items per page

idinteger

Filter by id

namestring

Filter by name

remarkstring

Exact remark filter; empty matches channels without remarks

backup_onlyboolean

Filter backup-only channels; omit for all channels

keystring

Filter by key

channel_typeinteger

Filter by channel type

base_urlstring

Filter by base URL

orderstring

Order by field

Response

OK

dataobject
messagestring
successboolean

Changes

    • info

      added the new optional query request parameter backup_only

    • info

      added the new optional query request parameter remark

    • info

      the query request parameter keyword became optional