PUT
/api/event-streaming/{id}Update Event Streaming Integration
Updates an existing event streaming integration. The request body structure is CreateIntegrationRequest.
However, for updates:
- The
platformfield, if provided in the body, is ignored by the backend manager function, as the platform of an existing integration is typically immutable. - The
enabledandconfigfields from the request body are used to update the integration.
idintegerrequired
The unique numeric identifier of the event streaming integration.
configobjectrequired
Platform-specific configuration as key-value pairs. For creation, all necessary credentials and settings must be provided. For updates, provide the fields to change or the entire new configuration.
enabledbooleanrequired
Specifies whether the integration is enabled. During creation (POST), this value is sent by the client, but the provided backend manager function `CreateIntegration` does not appear to use it directly, so its effect on creation should be verified. During updates (PUT), this field is used to enable or disable the integration.
platformstringrequired
The event streaming platform to integrate with (e.g., "datadog", "s3", "firehose"). This field is used for creation. For updates (PUT), this field, if sent, is ignored by the backend.
200Integration updated successfully. Returns the updated integration.
account_idstringoptional
The identifier of the account this integration belongs to.
configobjectoptional
Configuration for the integration. Sensitive keys (like API keys, secret keys) are masked with '****' in responses, as indicated by the GetIntegration handler logic.
created_atstringoptional
Timestamp of when the integration was created.
enabledbooleanoptional
Whether the integration is currently active.
idintegeroptional
The unique numeric identifier for the integration.
platformstringoptional
The event streaming platform.
updated_atstringoptional
Timestamp of when the integration was last updated.
400Bad Request (e.g., invalid JSON, validation error, invalid ID).
messagestringoptional
A human-readable error message.
401Unauthorized.
messagestringoptional
A human-readable error message.
404Not Found.
messagestringoptional
A human-readable error message.
500Internal Server Error.
messagestringoptional
A human-readable error message.
Error handling
A 400 is returned: Bad Request (e.g., invalid JSON, validation error, invalid ID). A 401 is returned: Unauthorized. A 404 is returned: Not Found. A 500 is returned: Internal Server Error.