> ## 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 upsert Catalog Entities > Create or update multiple catalog entities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all succeed or all fail. ## OpenAPI ````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json post /v1/catalogs/{catalog_id}/entities/bulk_upsert 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 ```
# 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_upsert: parameters: - name: catalog_id in: path required: true schema: type: string post: tags: - CatalogEntities summary: Bulk upsert Catalog Entities description: >- Create or update multiple catalog entities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all succeed or all fail. operationId: bulkUpsertCatalogEntities parameters: [] requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/bulk_upsert_catalog_entities' required: true responses: '200': description: entities upserted successfully content: application/vnd.api+json: schema: $ref: '#/components/schemas/bulk_upsert_catalog_entities_response' '401': description: unauthorized content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' '422': description: validation or entity-level error content: application/vnd.api+json: schema: anyOf: - $ref: '#/components/schemas/errors_list' - $ref: '#/components/schemas/bulk_upsert_catalog_entities_error' security: - bearer_auth: [] components: schemas: bulk_upsert_catalog_entities: type: object properties: entities: type: array description: >- Array of catalog entities to upsert. Each must have an external_id. Max 100 per request. external_ids must be unique within a batch. items: type: object properties: external_id: type: string description: >- External identifier used as the upsert key. Must be unique within the catalog. name: type: string description: >- Required for new entities. Optional for updates (managed-fields: omitted attributes are preserved). description: type: string nullable: true backstage_id: type: string nullable: true fields: type: array description: >- Property values for this entity. Only mentioned fields are written; unmentioned fields are preserved. items: type: object description: >- Each field entry must include either catalog_field_id or catalog_property_id. properties: catalog_field_id: type: string description: >- UUID, slug, or external_id of the catalog field (required if catalog_property_id is absent) catalog_property_id: type: string description: >- Alias for catalog_field_id (required if catalog_field_id is absent) value: type: string description: The value for this field required: - value required: - external_id required: - entities bulk_upsert_catalog_entities_response: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string enum: - catalog_entities attributes: type: object allOf: - $ref: '#/components/schemas/catalog_entity' included: type: array items: $ref: '#/components/schemas/jsonapi_included_resource' 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 bulk_upsert_catalog_entities_error: type: object required: - errors properties: errors: type: array items: type: object required: - index - external_id - errors properties: index: type: integer description: Position of the failed entity in the batch external_id: type: string errors: type: array items: type: string catalog_entity: type: object properties: name: type: string description: type: string nullable: true position: type: integer description: Default position of the item when displayed in a list. nullable: true backstage_id: type: string description: The Backstage entity ID this catalog entity is linked to. nullable: true external_id: type: string description: >- An external identifier for this catalog entity. Must be unique within the catalog. nullable: true managed_by: type: string enum: - web - admin_web - api - terraform - pulumi - backstage - catalog_sync description: Which source manages this resource (read-only). created_at: type: string updated_at: type: string properties: type: array description: Array of property values for this catalog entity items: type: object properties: catalog_property_id: type: string description: Unique ID of the catalog property value: type: string description: The value for this property required: - catalog_property_id - value required: - name - position - created_at - updated_at jsonapi_included_resource: type: object properties: id: type: string type: type: string attributes: type: object additionalProperties: true relationships: type: object additionalProperties: true required: - id - type securitySchemes: bearer_auth: type: http scheme: bearer ````