genroc

    docs / Reference / REST API

    Channels

    The 5 HTTP endpoints under Channels.

    PUT /api/channels

    Set a channel pointer to a specific process version

    Requires the deploy permission (or admin).

    Request

    {
      "name": "order_pipeline",
      "channel": "stable",
      "version": 3
    }

    Response

    {
      "channel": "stable",
      "name": "order_pipeline",
      "version": 3
    }

    Fails with 400, 404, 500.

    DELETE /api/channels

    Remove a channel pointer from a process

    Requires the deploy permission (or admin).

    Request

    {
      "name": "order_pipeline",
      "channel": "stable"
    }

    Response

    {
      "deleted": true
    }

    Fails with 400, 500.

    GET /api/channels

    List all channels for a process

    Requires the read permission (or admin).

    ParameterInDescription
    namequeryProcess name
    sortquerySort key (per-endpoint whitelist; omit for the default)
    orderquerySort direction (omit for the endpoint default). One of asc, desc.
    limitqueryPage size (default 20, cap 100)
    afterqueryCursor from a previous page's page.next_cursor — fetch the next page
    beforequeryCursor from a previous page's page.previous_cursor — fetch the previous page

    Response

    {
      "items": null,
      "page": {
        "size": 0,
        "items_before": 0,
        "items_after": 0,
        "sort": "",
        "order": ""
      }
    }

    Fails with 400, 500.

    POST /api/channels/promote

    Copy all channel pointers from one channel to another (optionally scoped to a process subtree)

    Requires the deploy permission (or admin).

    Request

    {
      "from": "staging",
      "to": "latest"
    }

    Response

    {
      "from": "staging",
      "promoted": [],
      "to": "latest"
    }

    Fails with 400, 404, 500.

    POST /api/channels/status

    Report stale child references within a channel

    Requires the read permission (or admin).

    Request

    {
      "channel": "latest"
    }

    Response

    {
      "items": []
    }

    Fails with 400, 404, 500.