Service Retention Period gRPC API

Adjust your service retention period with the Service Retention Period gRPC API.

Overview

This documentation details the Service Retention Period gRPC API, empowering you to modify the default 30-day period for removing services from your Service Catalog or databases from your Database Catalog in the absence of traffic.

Permissions

To utilize the API, you must have the service-catalog:Update permission. This permission is automatically granted to the following roles: Data Admin, Platform Admin, Observability Lead, and Legacy Admin. Find out more here.

Prerequisites

Alerts, Rules & Tags API key to successfully authenticate
Management API endpoint that corresponds with your Coralogix domain

API Endpoints

This reference document lists example requests and responses using gRPCurl. The following calls accept arguments as JSON in the request body and return results as JSON in the response body. A complete list of Management endpoints is available here.

Authentication

Coralogix API uses API keys to authenticate requests. You can view and manage your API keys from the Data Flow tab in Coralogix. You need to use this API key in the Authorization request header to connect successfully.

REQUEST

Below is the complete request header for the Service Catalog and Database Catalog. For both, input the gRPC endpoint associated with your Coralogix domain. The request payload should include the following structure:

Service Catalog:

grpcurl -H "Authorization: Bearer <PERSONAL_API_KEY>" -d @ n<cx-gprc-endpoint> com.coralogixapis.service_catalog.v1.ApmSettingsService/ReplaceRetentionPeriod <<EOF
{
    "retention_period_in_days": <value>,
    "catalog": "SERVICE_CATALOG"
}
EOF

Database Catalog:

grpcurl -H "Authorization: Bearer <PERSONAL_API_KEY>" -d @ <cx-gprc-endpoint> com.coralogixapis.service_catalog.v1.ApmSettingsService/ReplaceRetentionPeriod <<EOF
{
    "retention_period_in_days": <value>,
    "catalog": "DATABASE_CATALOG"
}
EOF

Additional resources


Documentation	Service Catalog Database Monitoring APM Onboarding Tutorial

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].

Custom Enrichment API

Next TCO Tracing Policy gRPC API