Create Retention Policy
const url = 'https://example.com/observability/v1/workspaces/example/engines/example/retention-policies';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"location_id":"example","qibdo":{"logs_interactive_seconds":"example","metrics_interactive_seconds":"example","traces_interactive_seconds":"example","activity_interactive_seconds":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/observability/v1/workspaces/example/engines/example/retention-policies \ --header 'Content-Type: application/json' \ --data '{ "location_id": "example", "qibdo": { "logs_interactive_seconds": "example", "metrics_interactive_seconds": "example", "traces_interactive_seconds": "example", "activity_interactive_seconds": "example" } }'Creates the workspace’s retention policy on the given provider. A specific provider is required.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace to create the retention policy in.
The provider: qibdo, aws, gcp, or azure (a specific provider is required for create).
Request Body required
Section titled “Request Body required ”A retention policy governs how long telemetry is kept for a workspace, per signal
pillar (logs, metrics, traces, activity). One policy exists per workspace. The
provider that stores the telemetry is reported by the read-only engine field.
object
The unique identifier of the retention policy.
The workspace this policy governs. Derived from the {workspace} path segment on create;
reported read-only thereafter.
Weak reference to a topology Location — where the telemetry resides. Immutable after create.
The provider that stores this workspace’s telemetry.
Timestamp when the policy was created.
Timestamp when the policy was last updated.
Retention windows for a Qibdo-managed workspace.
object
Interactive log retention window, in seconds (> 0).
Interactive metric retention window, in seconds (> 0).
Interactive trace retention window, in seconds (> 0).
Interactive activity retention window, in seconds (> 0).
Responses
Section titled “ Responses ”OK
ObservabilityOperation
Tracks the synchronous result of an observability config-plane command (retention, sink, or ingestion mutation). Engine-neutral — operations carry no engine axis.
object
The unique operation identifier.
The id of the affected resource.
The type of resource the operation acted upon (URN).
The operation type (CREATE, UPDATE, DELETE).
The operation status (DONE for synchronous config mutations).
When the operation was recorded.
When execution started.
When execution completed.
Progress percentage (0–100).
Example
{ "operation_type": "OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED", "status": "OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED"}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}