Coralogix Retentions Service API

View and manage retentions

Operations 4

GET /dataengine/retention-tags/v1 Get Retentions #
POST /dataengine/retention-tags/v1 Update Retentions #
POST /dataengine/retention-tags/v1/activate Activate Retentions #
GET /dataengine/retention-tags/v1/enabled Get Retentions Enabled #

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/coralogix:coralogix-retentions-service-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.

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

OpenAPI Specification

coralogix-retentions-service-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Coralogix Management Retentions Service API
  version: '5'
  description: 'Management API for the Coralogix observability platform. The base URL is region-specific: pick the `servers` entry matching your Coralogix domain. Authentication is a bearer API key.'
servers:
- url: https://api.eu1.coralogix.com/mgmt/openapi/5
- url: https://api.eu2.coralogix.com/mgmt/openapi/5
- url: https://api.us1.coralogix.com/mgmt/openapi/5
- url: https://api.us2.coralogix.com/mgmt/openapi/5
- url: https://api.us3.coralogix.com/mgmt/openapi/5
- url: https://api.ap1.coralogix.com/mgmt/openapi/5
- url: https://api.ap2.coralogix.com/mgmt/openapi/5
- url: https://api.ap3.coralogix.com/mgmt/openapi/5
- url: https://api.gov1.coralogixgov.us/mgmt/openapi/5
security:
- apiKeyAuth: []
tags:
- name: Retentions Service
  description: View and manage retentions
paths:
  /dataengine/retention-tags/v1:
    get:
      description: Returns all available retention tags.
      operationId: RetentionsService_GetRetentions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRetentionsResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Get Retentions
      tags:
      - Retentions Service
    post:
      description: Creates a new retention tag.
      operationId: RetentionsService_UpdateRetentions
      requestBody:
        content:
          application/json:
            schema:
              properties:
                retentionUpdateElements:
                  description: List of retention tag updates to apply.
                  items:
                    $ref: '#/components/schemas/RetentionUpdateElement'
                  minItems: 0
                  type: array
              required:
              - retentionUpdateElements
              title: Update Retentions Request
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRetentionsResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Update Retentions
      tags:
      - Retentions Service
  /dataengine/retention-tags/v1/activate:
    post:
      description: Activates the specified retention tags.
      operationId: RetentionsService_ActivateRetentions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivateRetentionsResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Activate Retentions
      tags:
      - Retentions Service
  /dataengine/retention-tags/v1/enabled:
    get:
      description: Returns the enabled retention tags for the team.
      operationId: RetentionsService_GetRetentionsEnabled
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRetentionsEnabledResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Get Retentions Enabled
      tags:
      - Retentions Service
components:
  schemas:
    GetRetentionsResponse:
      type: object
      properties:
        retentions:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/archive.v1.Retention'
          description: The retentions.
      description: Response containing the current data retention settings.
    GetRetentionsEnabledResponse:
      title: Get Retentions Enabled Response
      type: object
      properties:
        enableTags:
          description: The enable tags.
          type: boolean
          x-coralogix-presence: true
      description: This data structure is obtained when retrieving the active status of retentions
      externalDocs:
        description: Find out more about archives
        url: https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
    ActivateRetentionsResponse:
      title: Activate Retentions Response
      type: object
      properties:
        activateRetentions:
          description: List of retentions to activate.
          examples:
          - true
          type: boolean
          x-coralogix-presence: true
      description: This data structure is obtained after setting the active status of retentions
      externalDocs:
        description: Find out more about archives
        url: https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
    Error:
      type: object
      properties:
        code:
          maximum: 599
          minimum: 100
          type: integer
          description: HTTP status code of the error (for example 400, 404, 500).
          format: int32
        message:
          maxLength: 4096
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description of the error.
      description: Standard error response body returned for a failed request.
    RetentionUpdateElement:
      type: object
      properties:
        id:
          description: Unique identifier.
          minLength: 0
          type: string
          x-coralogix-presence: true
        name:
          description: Display name.
          minLength: 0
          type: string
          x-coralogix-presence: true
    UpdateRetentionsResponse:
      title: Update Retentions Response
      required:
      - retentions
      type: object
      properties:
        retentions:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/archive.v1.Retention'
          description: The retentions.
      description: This data structure is obtained after updating retentions
      externalDocs:
        description: Find out more about archives
        url: https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
    archive.v1.Retention:
      title: Retention
      type: object
      properties:
        editable:
          description: The editable.
          type: boolean
          x-coralogix-presence: true
        id:
          description: Unique identifier.
          minLength: 0
          type: string
          x-coralogix-presence: true
        name:
          description: Display name.
          minLength: 0
          type: string
          x-coralogix-presence: true
        order:
          description: Sort order.
          format: int32
          type: integer
          x-coralogix-presence: true
      externalDocs:
        description: Find out more about archives
        url: https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication
externalDocs:
  description: Coralogix API reference
  url: https://coralogix.com/docs/api-reference/v5/
x-provenance:
  method: harvested
  publisher: Coralogix
  source: https://coralogix.com/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)