For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.functions.update_trigger(
    namespace_id="fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    trigger_name="my trigger",
    body={
        "is_enabled": True,
        "scheduled_details": {...},
    },
)

Description

Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/{namespace_id}/triggers/{trigger_name} with new values for the is_enabled or scheduled_details properties.

Parameters

namespace_id string required

The ID of the namespace to be managed.

trigger_name string required

The name of the trigger to be managed.

is_enabled boolean optional

Example: True

Indicates weather the trigger is paused or unpaused.

scheduled_details object optional

Trigger details for SCHEDULED type, where body is optional.

Show child properties

cron string required

Example: * * * * *

valid cron expression string which is required for SCHEDULED type triggers.

body object or null optional

Optional data to be sent to function while triggering the function.

Show child properties

name string optional

Example: Welcome to DO!

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "is_enabled": true,
  "scheduled_details": {
    "cron": "* * * * *",
    "body": {
      "name": "Welcome to DO!"
    }
  }
}

resp = client.functions.update_trigger(namespace_id="39f3ca", trigger_name="trig_name", body=req)

Response Example

{
  "trigger": {
    "namespace": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "my trigger",
    "function": "hello",
    "type": "SCHEDULED",
    "is_enabled": true,
    "created_at": "2022-11-11T04:16:45Z",
    "updated_at": "2022-11-11T04:16:45Z",
    "scheduled_details": {
      "cron": "* * * * *"
    },
    "scheduled_runs": {
      "last_run_at": "2022-11-11T04:16:45Z",
      "next_run_at": "2022-11-11T04:16:45Z"
    }
  }
}

More Information

See /v2/functions/namespaces/{namespace_id}/triggers/{trigger_name} in the API reference for additional detail on responses, headers, parameters, and more.