> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rootly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bulk delete Catalog Entities

> Delete catalog entities by external_id list, or prune by managed_by source. Two mutually exclusive modes.



## OpenAPI

````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json post /v1/catalogs/{catalog_id}/entities/bulk_delete
openapi: 3.0.1
info:
  title: Rootly API v1
  version: v1
  description: >+
    # How to generate an API Key?

    - **Organization dropdown** > **Organization Settings** > **API Keys**


    # JSON:API Specification

    Rootly is using **JSON:API** (https://jsonapi.org) specification:

    - JSON:API is a specification for how a client should request that resources
    be fetched or modified, and how a server should respond to those requests.

    - JSON:API is designed to minimize both the number of requests and the
    amount of data transmitted between clients and servers. This efficiency is
    achieved without compromising readability, flexibility, or discoverability.

    - JSON:API requires use of the JSON:API media type
    (**application/vnd.api+json**) for exchanging data.


    # Authentication and Requests

    We use standard HTTP Authentication over HTTPS to authorize your requests.

    ```
      curl --request GET \
    --header 'Content-Type: application/vnd.api+json' \

    --header 'Authorization: Bearer YOUR-TOKEN' \

    --url https://api.rootly.com/v1/incidents

    ```


    <br/>


    # Rate limiting

    - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls
    **per API key** every **60 seconds** (0 hours). The limit is calculated over
    a **0-hour sliding window** looking back from the current time. While the
    limit can be configured to support higher thresholds, you must first contact
    your **Rootly Customer Success Manager** to make any adjustments.

    - There is a default limit of **3** **POST**, **PUT**, **PATCH** or
    **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit
    is calculated over a **0-hour sliding window** looking back from the current
    time. While the limit can be configured to support higher thresholds, you
    must first contact your **Rootly Customer Success Manager** to make any
    adjustments.

    - When rate limits are exceeded, the API will return a **429 Too Many
    Requests** HTTP status code with the response: `{"error": "Rate limit
    exceeded. Try again later."}`

    - **X-RateLimit headers** are included in every API response, providing
    real-time rate limit information:
      - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour)
      - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window
      - **X-RateLimit-Used** - The number of requests already made in the current window
      - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds

    # Pagination

    - Pagination is supported for all endpoints that return a collection of
    items.

    - Pagination is controlled by the **page** query parameter


    ## Example

    ```
      curl --request GET \
    --header 'Content-Type: application/vnd.api+json' \

    --header 'Authorization: Bearer YOUR-TOKEN' \

    --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10

    ```

  x-logo:
    url: https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png
servers:
  - url: https://api.rootly.com
security: []
paths:
  /v1/catalogs/{catalog_id}/entities/bulk_delete:
    parameters:
      - name: catalog_id
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
        - CatalogEntities
      summary: Bulk delete Catalog Entities
      description: >-
        Delete catalog entities by external_id list, or prune by managed_by
        source. Two mutually exclusive modes.
      operationId: bulkDeleteCatalogEntities
      parameters: []
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/bulk_destroy_catalog_entities'
        required: true
      responses:
        '200':
          description: entities deleted successfully
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/bulk_destroy_catalog_entities_response'
        '401':
          description: unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_list'
        '422':
          description: validation or partial-failure error
          content:
            application/vnd.api+json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/errors_list'
                  - $ref: >-
                      #/components/schemas/bulk_destroy_catalog_entities_response
      security:
        - bearer_auth: []
components:
  schemas:
    bulk_destroy_catalog_entities:
      description: >-
        Two mutually exclusive modes. Pass exactly one of: external_ids (delete
        specific entities) or managed_by (prune all managed entities not in keep
        set).
      oneOf:
        - type: object
          required:
            - external_ids
          additionalProperties: false
          properties:
            external_ids:
              type: array
              description: Array of external_ids to delete. Max 100 per request.
              items:
                type: string
                minLength: 1
              minItems: 1
        - type: object
          required:
            - managed_by
          additionalProperties: false
          properties:
            managed_by:
              type: string
              enum:
                - api
                - terraform
                - pulumi
                - backstage
                - catalog_sync
              description: >-
                Delete all entities with this managed_by value (web/admin_web
                not allowed).
            keep_external_ids:
              type: array
              description: Entities with these external_ids are preserved.
              items:
                type: string
    bulk_destroy_catalog_entities_response:
      type: object
      properties:
        data:
          type: object
          properties:
            deleted_external_ids:
              type: array
              items:
                type: string
              description: External IDs that were successfully deleted
            failed_external_ids:
              type: array
              items:
                type: string
              description: >-
                External IDs where destroy failed (e.g. protected/synced
                entities)
            not_found_external_ids:
              type: array
              items:
                type: string
              description: >-
                External IDs that were not found (only present in external_ids
                mode)
    errors_list:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              status:
                type: string
              code:
                type: string
                nullable: true
              detail:
                type: string
                nullable: true
            required:
              - title
              - status
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````