Cribl

Cribl Retention API

Configure data retention policies that control how long data is stored in Lake datasets before automatic cleanup.

Documentation GitHub OpenAPI

Operations 2

GET /lake/datasets/{id}/retention Get dataset retention policy #

PATCH /lake/datasets/{id}/retention Update dataset retention policy #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cribl-retention-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cribl Lake Retention API
  description: The Cribl Lake API provides programmatic access to Cribl Lake, a data lake solution purpose-built for observability and security data. The API enables developers to manage data storage, retention policies, and access controls for large volumes of telemetry data. Cribl Lake stores data in open formats, making it accessible to any analytics tool, and provides cost-effective long-term storage that keeps data usable and valuable to the teams and tools that need it. Lake API endpoints are accessible through the Cribl Cloud control plane.
  version: '1.0'
  contact:
    name: Cribl Support
    url: https://cribl.io/support/
  termsOfService: https://cribl.io/terms-of-service/
servers:
- url: https://{workspaceName}-{organizationId}.cribl.cloud/api/v1
  description: Cribl Cloud
  variables:
    workspaceName:
      default: default
      description: The name of the Cribl Cloud workspace
    organizationId:
      default: org-id
      description: The Cribl Cloud organization identifier
security:
- bearerAuth: []
tags:
- name: Retention
  description: Configure data retention policies that control how long data is stored in Lake datasets before automatic cleanup.
paths:
  /lake/datasets/{id}/retention:
    get:
      operationId: getLakeDatasetRetention
      summary: Get dataset retention policy
      description: Retrieves the retention policy for a specific Lake dataset including the retention period and cleanup schedule.
      tags:
      - Retention
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Successfully retrieved retention policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionPolicy'
        '401':
          description: Unauthorized
        '404':
          description: Dataset not found
    patch:
      operationId: updateLakeDatasetRetention
      summary: Update dataset retention policy
      description: Updates the retention policy for a Lake dataset controlling how long data is stored before automatic cleanup.
      tags:
      - Retention
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetentionPolicy'
      responses:
        '200':
          description: Retention policy updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionPolicy'
        '400':
          description: Invalid retention policy
        '401':
          description: Unauthorized
        '404':
          description: Dataset not found
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource
      schema:
        type: string
  schemas:
    RetentionPolicy:
      type: object
      properties:
        retentionDays:
          type: integer
          description: Number of days to retain data before cleanup
          minimum: 1
        enabled:
          type: boolean
          description: Whether automatic retention cleanup is enabled
        cleanupSchedule:
          type: string
          description: Cron schedule for running retention cleanup
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained via OAuth 2.0 client credentials grant for Cribl Cloud authentication. Tokens expire after 24 hours.
externalDocs:
  description: Cribl Lake Documentation
  url: https://docs.cribl.io/lake/