--- title: "Update forwarding endpoint" method: PATCH path: "/v1beta1/telemetryrelay/endpoints/{ref.slug}" tags: ["TelemetryRelayService"] --- # Update forwarding endpoint `PATCH /v1beta1/telemetryrelay/endpoints/{ref.slug}` Updates a forwarding endpoint identified by `ref.slug`. The request body must include the full `spec`. The endpoint's protocol type cannot change after creation. Credentials are optional on update. If omitted, existing credentials are preserved; if provided, the credential type must match the endpoint's protocol. ## Path parameters - `ref.slug` string, required ## Request body - CoreweaveTelemetryrelaySvcClusterV1beta1UpdateEndpointRequest - `ref` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointRef, required — ForwardingEndpointRef uniquely identifies a forwarding endpoint within an organization. Endpoints are referenced by a human-readable slug that must be unique per organization. - `slug` string, required — slug is a unique identifier for the endpoint within the organization. Must be 3-32 characters, start with alphanumeric, and contain only alphanumeric and hyphens. - `spec` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointSpec, required — Configuration for a forwarding endpoint. Includes a human-readable `displayName` and exactly one protocol-specific config. The protocol type is fixed at creation time and cannot be changed afterwards. - `displayName` string, required — display_name is a human-readable name for this endpoint. Used for display purposes in UIs and logs. - `https` CoreweaveTelemetryrelayTypesV1beta1HTTPSConfig — HTTPSConfig configures a generic HTTPS endpoint for custom integrations. Allows forwarding telemetry data to any HTTPS endpoint. Useful for custom receivers or third-party services. Authentication: If the endpoint requires HTTP Basic authentication, provide HTTPSCredentials when creating/updating the endpoint. If no credentials are provided, requests are sent without authentication. - `endpoint` string, required — endpoint is the URL of the HTTPS endpoint. Must be a valid HTTPS URL; plain HTTP is rejected. Targets that resolve to loopback, private, or link-local addresses are rejected by the service at submission time to prevent SSRF (see O11Y-2851). - `tls` CoreweaveTelemetryrelayTypesV1beta1TLSConfig — TLSConfig configures TLS settings for secure connections. Used when connecting to endpoints that require custom CA certificates or specific TLS configuration. - `certificateAuthorityData` string — certificate_authority_data contains the PEM-encoded CA certificate bundle. Must be base64-encoded when transmitted. If not provided, the system's default trust store is used. - `credentialAction` 'CREDENTIAL_ACTION_PRESERVE' | 'CREDENTIAL_ACTION_REPLACE' | 'CREDENTIAL_ACTION_CLEAR', enum — Controls how the endpoint's stored credentials are handled during the update. `CREDENTIAL_ACTION_PRESERVE` keeps the existing credentials unchanged. `CREDENTIAL_ACTION_REPLACE` replaces them with the credentials supplied in this request; credentials must be provided when this action is used. `CREDENTIAL_ACTION_CLEAR` removes the stored credentials. - `https` CoreweaveTelemetryrelayTypesV1beta1HTTPSCredentials — HTTPSCredentials contains authentication credentials for HTTPS endpoints. Supports HTTP Basic authentication, bearer tokens, and custom auth headers. Future versions may support OAuth or mTLS client certificates. - `basicAuth` CoreweaveTelemetryrelayTypesV1beta1BasicAuthCredentials — BasicAuthCredentials contains username and password for HTTP Basic authentication. This is a reusable credential type for any endpoint that uses HTTP Basic authentication, including generic HTTPS endpoints. Credentials are encrypted at rest and in transit. - `username` string, required — username for HTTP Basic authentication. Must be non-empty. - `password` string, required — password for HTTP Basic authentication. This field is write-only and never returned in responses. - `bearerToken` CoreweaveTelemetryrelayTypesV1beta1BearerTokenCredentials — BearerTokenCredentials contains a bearer token for HTTP Authorization header authentication. Used for APIs that require "Authorization: Bearer " authentication. Common with OAuth 2.0, JWT tokens, and many modern APIs. The token is encrypted at rest and in transit. - `token` string, required — token is the bearer token value. This field is write-only and never returned in responses. - `authHeaders` CoreweaveTelemetryrelayTypesV1beta1AuthHeadersCredentials — AuthHeadersCredentials contains custom HTTP headers for authentication. Used for APIs that require authentication via custom headers (e.g., X-API-Key, X-Auth-Token). All header values are encrypted at rest and in transit. Header names are case-insensitive per HTTP specification. - `headers` object, required — headers is a map of HTTP header names to values for authentication. Common examples: {"X-API-Key": "key123"}, {"X-Auth-Token": "token456"} All values are write-only and never returned in responses. ## Response `200` OK - CoreweaveTelemetryrelaySvcClusterV1beta1UpdateEndpointResponse - `endpoint` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpoint — ForwardingEndpoint represents a destination where telemetry data can be forwarded. Endpoints are organization-scoped and identified by a unique slug. Self-service endpoints forward over HTTPS. - `ref` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointRef, required — ForwardingEndpointRef uniquely identifies a forwarding endpoint within an organization. Endpoints are referenced by a human-readable slug that must be unique per organization. - `slug` string, required — slug is a unique identifier for the endpoint within the organization. Must be 3-32 characters, start with alphanumeric, and contain only alphanumeric and hyphens. - `spec` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointSpec, required — Configuration for a forwarding endpoint. Includes a human-readable `displayName` and exactly one protocol-specific config. The protocol type is fixed at creation time and cannot be changed afterwards. - `displayName` string, required — display_name is a human-readable name for this endpoint. Used for display purposes in UIs and logs. - `https` CoreweaveTelemetryrelayTypesV1beta1HTTPSConfig — HTTPSConfig configures a generic HTTPS endpoint for custom integrations. Allows forwarding telemetry data to any HTTPS endpoint. Useful for custom receivers or third-party services. Authentication: If the endpoint requires HTTP Basic authentication, provide HTTPSCredentials when creating/updating the endpoint. If no credentials are provided, requests are sent without authentication. - `endpoint` string, required — endpoint is the URL of the HTTPS endpoint. Must be a valid HTTPS URL; plain HTTP is rejected. Targets that resolve to loopback, private, or link-local addresses are rejected by the service at submission time to prevent SSRF (see O11Y-2851). - `tls` CoreweaveTelemetryrelayTypesV1beta1TLSConfig — TLSConfig configures TLS settings for secure connections. Used when connecting to endpoints that require custom CA certificates or specific TLS configuration. - `certificateAuthorityData` string — certificate_authority_data contains the PEM-encoded CA certificate bundle. Must be base64-encoded when transmitted. If not provided, the system's default trust store is used. - `status` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointStatus — ForwardingEndpointStatus reflects the current operational state of an endpoint. Status is managed by the system and includes connection state, timestamps, and information about which zones/clusters are actively using the endpoint. - `createdAt` string, date-time — created_at is when the endpoint was first created. - `updatedAt` string, date-time — updated_at is when the endpoint configuration was last modified. - `state` 'FORWARDING_ENDPOINT_STATE_PENDING' | 'FORWARDING_ENDPOINT_STATE_CONNECTED' | 'FORWARDING_ENDPOINT_STATE_ERROR', enum — Current operational state of the endpoint. `PENDING` while the endpoint is being provisioned, `CONNECTED` once the endpoint is operational and receiving data, `ERROR` when the endpoint encountered an error and is not operational. - `stateMessage` string — state_message provides additional context about the current state. Especially useful when state is ERROR to describe what went wrong. - `zonesActive` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointStatusZoneClusterStatus[] — zones_active lists which zones and clusters are actively forwarding data to this endpoint. - `zoneSlug` string — zone_slug identifies the zone. - `clusters` CoreweaveTelemetryrelayTypesV1beta1ForwardingEndpointStatusClusterStatus[] — clusters is the list of clusters in this zone using the endpoint. - `id` string — id is the cluster's unique identifier. - `credentialsConfigured` boolean — credentials_configured indicates whether credentials have been set for this endpoint. Does not indicate if the credentials are valid, only that they exist. - `credentialsUpdatedAt` string, date-time — credentials_updated_at is when credentials were last set or updated. Unset if credentials have never been configured. ## Other responses - `default` — Default error response --- [API](https://skmtc.dev/coreweave/apis/coreweave-telemetry-relay-api.md) · [All operations](https://skmtc.dev/coreweave/apis/coreweave-telemetry-relay-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/coreweave/coreweave-telemetry-relay-api/revisions/3b98ea4fe0c3/schema)