diff --git a/DO_OPENAPI_COMMIT_SHA.txt b/DO_OPENAPI_COMMIT_SHA.txt index ae3279f8..6f77212f 100644 --- a/DO_OPENAPI_COMMIT_SHA.txt +++ b/DO_OPENAPI_COMMIT_SHA.txt @@ -1 +1 @@ -4a87b3b +e6e0529 diff --git a/src/pydo/aio/operations/_operations.py b/src/pydo/aio/operations/_operations.py index 9fd2e5f3..0f3aa5b0 100644 --- a/src/pydo/aio/operations/_operations.py +++ b/src/pydo/aio/operations/_operations.py @@ -163237,10 +163237,10 @@ async def list_notification_channels( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming - webhook URL. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. Omit on update to retain the existing - value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules @@ -163248,29 +163248,31 @@ async def list_notification_channels( }, "webhook": { "url": "str", # HTTPS URL that receives webhook - deliveries. Returned in full on read. Required. + deliveries. Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth - password. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + "password_status": { + "configured": bool # Whether the + secret is configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token - value sent in the Authorization header. Write-only secret "u2014 - full value on create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the + secret is configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom - HTTP headers to include on webhook deliveries. At most 20 headers - are allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + HTTP headers included on webhook deliveries. At most 20 headers + are allowed. }, "signature": { - "secret": "str" # Optional. Shared secret - used to sign webhook payloads. Write-only secret "u2014 full - value on create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the + secret is configured. Required. + } } } } @@ -163355,7 +163357,8 @@ async def create_notification_channel( Email recipients must be verified team member addresses. Webhook URLs must use HTTPS. Secret fields (\\ ``slack.webhook_url``\\ , webhook credentials) are - write-only and returned masked on subsequent reads. + write-only. Subsequent reads never return secret values; they include + optional ``*_status`` objects when a secret is configured. :param body: Required. :type body: JSON @@ -163380,8 +163383,8 @@ async def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -163389,13 +163392,14 @@ async def create_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -163405,8 +163409,9 @@ async def create_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -163433,9 +163438,10 @@ async def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -163443,28 +163449,30 @@ async def create_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -163495,7 +163503,8 @@ async def create_notification_channel( Email recipients must be verified team member addresses. Webhook URLs must use HTTPS. Secret fields (\\ ``slack.webhook_url``\\ , webhook credentials) are - write-only and returned masked on subsequent reads. + write-only. Subsequent reads never return secret values; they include + optional ``*_status`` objects when a secret is configured. :param body: Required. :type body: IO[bytes] @@ -163531,9 +163540,10 @@ async def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -163541,28 +163551,30 @@ async def create_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -163593,7 +163605,8 @@ async def create_notification_channel( Email recipients must be verified team member addresses. Webhook URLs must use HTTPS. Secret fields (\\ ``slack.webhook_url``\\ , webhook credentials) are - write-only and returned masked on subsequent reads. + write-only. Subsequent reads never return secret values; they include + optional ``*_status`` objects when a secret is configured. :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] @@ -163615,8 +163628,8 @@ async def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -163624,13 +163637,14 @@ async def create_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -163640,8 +163654,9 @@ async def create_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -163668,9 +163683,10 @@ async def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -163678,28 +163694,30 @@ async def create_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -163813,8 +163831,10 @@ async def get_notification_channel(self, id: str, **kwargs: Any) -> JSON: """Retrieve a Notification Channel. To retrieve a notification channel, send a GET request to - ``/v2/insights/notification-channels/{id}``. Secret fields are returned masked - as ``********``. + ``/v2/insights/notification-channels/{id}``. Secret credentials are never + returned. When a secret is configured, the response includes an optional + ``*_status`` object (for example ``webhook_url_status``\\ ) with + ``configured: true``. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -163847,9 +163867,10 @@ async def get_notification_channel(self, id: str, **kwargs: Any) -> JSON: "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -163857,28 +163878,30 @@ async def get_notification_channel(self, id: str, **kwargs: Any) -> JSON: }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -163990,7 +164013,8 @@ async def update_notification_channel( ``email``\\ , ``slack``\\ , or ``webhook``. Sending a secret field rotates it; omitting the secret field keeps the - existing value. + existing value. Responses never return secret values; they include optional + ``*_status`` objects when a secret is configured. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -164017,8 +164041,8 @@ async def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -164026,13 +164050,14 @@ async def update_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -164042,8 +164067,9 @@ async def update_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -164070,9 +164096,10 @@ async def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -164080,28 +164107,30 @@ async def update_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -164136,7 +164165,8 @@ async def update_notification_channel( ``email``\\ , ``slack``\\ , or ``webhook``. Sending a secret field rotates it; omitting the secret field keeps the - existing value. + existing value. Responses never return secret values; they include optional + ``*_status`` objects when a secret is configured. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -164174,9 +164204,10 @@ async def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -164184,28 +164215,30 @@ async def update_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -164235,7 +164268,8 @@ async def update_notification_channel( ``email``\\ , ``slack``\\ , or ``webhook``. Sending a secret field rotates it; omitting the secret field keeps the - existing value. + existing value. Responses never return secret values; they include optional + ``*_status`` objects when a secret is configured. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -164259,8 +164293,8 @@ async def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -164268,13 +164302,14 @@ async def update_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -164284,8 +164319,9 @@ async def update_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -164312,9 +164348,10 @@ async def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -164322,28 +164359,30 @@ async def update_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } diff --git a/src/pydo/operations/_operations.py b/src/pydo/operations/_operations.py index d87cd17d..3716b5bb 100644 --- a/src/pydo/operations/_operations.py +++ b/src/pydo/operations/_operations.py @@ -181535,10 +181535,10 @@ def list_notification_channels( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming - webhook URL. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. Omit on update to retain the existing - value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules @@ -181546,29 +181546,31 @@ def list_notification_channels( }, "webhook": { "url": "str", # HTTPS URL that receives webhook - deliveries. Returned in full on read. Required. + deliveries. Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth - password. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + "password_status": { + "configured": bool # Whether the + secret is configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token - value sent in the Authorization header. Write-only secret "u2014 - full value on create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the + secret is configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom - HTTP headers to include on webhook deliveries. At most 20 headers - are allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + HTTP headers included on webhook deliveries. At most 20 headers + are allowed. }, "signature": { - "secret": "str" # Optional. Shared secret - used to sign webhook payloads. Write-only secret "u2014 full - value on create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the + secret is configured. Required. + } } } } @@ -181653,7 +181655,8 @@ def create_notification_channel( Email recipients must be verified team member addresses. Webhook URLs must use HTTPS. Secret fields (\\ ``slack.webhook_url``\\ , webhook credentials) are - write-only and returned masked on subsequent reads. + write-only. Subsequent reads never return secret values; they include + optional ``*_status`` objects when a secret is configured. :param body: Required. :type body: JSON @@ -181678,8 +181681,8 @@ def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -181687,13 +181690,14 @@ def create_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -181703,8 +181707,9 @@ def create_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -181731,9 +181736,10 @@ def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -181741,28 +181747,30 @@ def create_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -181793,7 +181801,8 @@ def create_notification_channel( Email recipients must be verified team member addresses. Webhook URLs must use HTTPS. Secret fields (\\ ``slack.webhook_url``\\ , webhook credentials) are - write-only and returned masked on subsequent reads. + write-only. Subsequent reads never return secret values; they include + optional ``*_status`` objects when a secret is configured. :param body: Required. :type body: IO[bytes] @@ -181829,9 +181838,10 @@ def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -181839,28 +181849,30 @@ def create_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -181891,7 +181903,8 @@ def create_notification_channel( Email recipients must be verified team member addresses. Webhook URLs must use HTTPS. Secret fields (\\ ``slack.webhook_url``\\ , webhook credentials) are - write-only and returned masked on subsequent reads. + write-only. Subsequent reads never return secret values; they include + optional ``*_status`` objects when a secret is configured. :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] @@ -181913,8 +181926,8 @@ def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -181922,13 +181935,14 @@ def create_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -181938,8 +181952,9 @@ def create_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -181966,9 +181981,10 @@ def create_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -181976,28 +181992,30 @@ def create_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -182111,8 +182129,10 @@ def get_notification_channel(self, id: str, **kwargs: Any) -> JSON: """Retrieve a Notification Channel. To retrieve a notification channel, send a GET request to - ``/v2/insights/notification-channels/{id}``. Secret fields are returned masked - as ``********``. + ``/v2/insights/notification-channels/{id}``. Secret credentials are never + returned. When a secret is configured, the response includes an optional + ``*_status`` object (for example ``webhook_url_status``\\ ) with + ``configured: true``. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -182145,9 +182165,10 @@ def get_notification_channel(self, id: str, **kwargs: Any) -> JSON: "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -182155,28 +182176,30 @@ def get_notification_channel(self, id: str, **kwargs: Any) -> JSON: }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -182288,7 +182311,8 @@ def update_notification_channel( ``email``\\ , ``slack``\\ , or ``webhook``. Sending a secret field rotates it; omitting the secret field keeps the - existing value. + existing value. Responses never return secret values; they include optional + ``*_status`` objects when a secret is configured. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -182315,8 +182339,8 @@ def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -182324,13 +182348,14 @@ def update_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -182340,8 +182365,9 @@ def update_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -182368,9 +182394,10 @@ def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -182378,28 +182405,30 @@ def update_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -182434,7 +182463,8 @@ def update_notification_channel( ``email``\\ , ``slack``\\ , or ``webhook``. Sending a secret field rotates it; omitting the secret field keeps the - existing value. + existing value. Responses never return secret values; they include optional + ``*_status`` objects when a secret is configured. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -182472,9 +182502,10 @@ def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -182482,28 +182513,30 @@ def update_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } } @@ -182533,7 +182566,8 @@ def update_notification_channel( ``email``\\ , ``slack``\\ , or ``webhook``. Sending a secret field rotates it; omitting the secret field keeps the - existing value. + existing value. Responses never return secret values; they include optional + ``*_status`` objects when a secret is configured. :param id: A unique identifier for a notification channel. Required. :type id: str @@ -182557,8 +182591,8 @@ def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as ``********`` - on read. Omit on update to retain the existing value. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. Returned @@ -182566,13 +182600,14 @@ def update_notification_channel( "basic_auth": { "username": "str", # Basic auth username. Required. "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + Write-only secret "u2014 send the full value on create or update. Omit on + update to retain the existing value. Never returned in responses. }, "bearer_token": { "token": "str" # Optional. Bearer token value sent in the - Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + Authorization header. Write-only secret "u2014 send the full value on + create or update. Omit on update to retain the existing value. Never + returned in responses. }, "headers": { "str": "str" # Optional. Optional custom HTTP headers to @@ -182582,8 +182617,9 @@ def update_notification_channel( }, "signature": { "secret": "str" # Optional. Shared secret used to sign - webhook payloads. Write-only secret "u2014 full value on create/update; - masked as ``********`` on read. + webhook payloads. Write-only secret "u2014 send the full value on create + or update. Omit on update to retain the existing value. Never returned in + responses. } } } @@ -182610,9 +182646,10 @@ def update_notification_channel( "slack": { "channel": "str", # The Slack channel name to notify. Required. - "webhook_url": "str" # Optional. Slack incoming webhook URL. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. Omit on update to retain the existing value. + "webhook_url_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "usage": { "rule_count": 0 # Optional. Number of alert rules that @@ -182620,28 +182657,30 @@ def update_notification_channel( }, "webhook": { "url": "str", # HTTPS URL that receives webhook deliveries. - Returned in full on read. Required. + Required. "basic_auth": { "username": "str", # Basic auth username. Required. - "password": "str" # Optional. Basic auth password. - Write-only secret "u2014 full value on create/update; masked as - ``********`` on read. + "password_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "bearer_token": { - "token": "str" # Optional. Bearer token value sent - in the Authorization header. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "token_status": { + "configured": bool # Whether the secret is + configured. Required. + } }, "headers": { "str": "str" # Optional. Optional custom HTTP - headers to include on webhook deliveries. At most 20 headers are - allowed. Reserved header names such as ``host``"" , - ``content-type``"" , and ``proxy-*`` are rejected. + headers included on webhook deliveries. At most 20 headers are + allowed. }, "signature": { - "secret": "str" # Optional. Shared secret used to - sign webhook payloads. Write-only secret "u2014 full value on - create/update; masked as ``********`` on read. + "secret_status": { + "configured": bool # Whether the secret is + configured. Required. + } } } }