CoreStack Background Jobs API

Manage Background Jobs

Operations 17

PUT /v1/admin/background_job/activation Sets the next activation time for the Background Job #
POST /v1/admin/background_job/batch Returns a batch of BackgroundJobs #
PUT /v1/admin/background_job/cancel Requests the cancellation of a job #
POST /v1/admin/background_job/forwarding_check Internal #
PUT /v1/admin/background_job/invalidation #
POST /v1/admin/background_job/list Returns a list of BackgroundJobs ids #
POST /v1/admin/background_job/log Returns a batch of log entries for BackgroundJob #
POST /v1/admin/background_job/logger/set-level Sets the level of a logger #
POST /v1/admin/background_job/loggers Returns a list of BackgroundJobs threads #
PUT /v1/admin/background_job/priority Sets the priority on Background Job #
POST /v1/admin/background_job/queue Queues a Background Job #
POST /v1/admin/background_job/stacktrace Returns the frames for the executing BackgroundJob #
POST /v1/admin/background_job/stats Returns statistics about the selected executors #
POST /v1/admin/background_job/threads Returns a list of BackgroundJobs threads #
POST /v1/background_job_handler/configuration Fetch the configuration of a Background Job Handler #
PUT /v1/background_job_handler/configuration Update the configuration of a Background Job Handler #
POST /v1/background_job_handler/list Lists the active Background Job Handlers #

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/corestack-background-jobs-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 email required.

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

OpenAPI Specification

corestack-background-jobs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CoreStack External Background Jobs API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Manage Background Jobs
servers:
- url: /
tags:
- name: Background Jobs
  description: Manage Background Jobs
paths:
  /v1/admin/background_job/activation:
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: boolean
      summary: Sets the next activation time for the Background Job
      description: Changes the activation of a Background Job
      operationId: BackgroundJobActivation
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobUpdateActivationRequest'
        required: true
  /v1/admin/background_job/batch:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobBatchResponse'
      summary: Returns a batch of BackgroundJobs
      description: Get details for the Background Job ids passed in the request
      operationId: BackgroundJobBatch
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobBatchRequest'
        required: true
  /v1/admin/background_job/cancel:
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Cancelled
          content:
            application/json:
              schema:
                type: boolean
      summary: Requests the cancellation of a job
      description: Request a Background Job to stop processing as soon as possible
      operationId: BackgroundJobCancel
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordIdentity'
        required: true
  /v1/admin/background_job/forwarding_check:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Checked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobForwardingCheckResponse'
      summary: Internal
      description: Verify federation route
      operationId: BackgroundJobForwardingCheck
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobForwardingCheckRequest'
        required: true
  /v1/admin/background_job/invalidation:
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Invalidated
          content:
            application/json:
              schema:
                type: boolean
      description: Request a Background Job to stop processing as soon as possible
      operationId: BackgroundJobInvalidation
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobInvalidation'
        required: true
  /v1/admin/background_job/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDetailedResponse'
      summary: Returns a list of BackgroundJobs ids
      description: Get the list of all Background Jobs.
      operationId: BackgroundJobList
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobListRequest'
        required: true
  /v1/admin/background_job/log:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Unknown Background Job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobLogResponse'
      summary: Returns a batch of log entries for BackgroundJob
      description: Get log entries for the Background Job passed in the request
      operationId: BackgroundJobLog
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobLogRequest'
        required: true
  /v1/admin/background_job/logger/set-level:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobLogger'
      summary: Sets the level of a logger
      description: Set the level of a logger for Background Jobs workers.
      operationId: BackgroundJobLoggerSet
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobLogger'
        required: true
  /v1/admin/background_job/loggers:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackgroundJobLogger'
      summary: Returns a list of BackgroundJobs threads
      description: Get loggers from all Background Jobs workers.
      operationId: BackgroundJobLoggers
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobLoggerRequest'
        required: true
  /v1/admin/background_job/priority:
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: boolean
      summary: Sets the priority on Background Job
      description: Changes the priority of a Background Job
      operationId: BackgroundJobPriority
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobUpdatePriorityRequest'
        required: true
  /v1/admin/background_job/queue:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Queue outcome
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobQueueResponse'
      summary: Queues a Background Job
      description: Queue a Background Job
      operationId: BackgroundJobQueue
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobQueueRequest'
        required: true
  /v1/admin/background_job/stacktrace:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Unknown Background Job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobThread'
      summary: Returns the frames for the executing BackgroundJob
      description: Get the stack trace for the executing Background Job passed in the request
      operationId: BackgroundJobStackTrace
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordIdentity'
        required: true
  /v1/admin/background_job/stats:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobStatisticsResponse'
      summary: Returns statistics about the selected executors
      description: Get statistics from all Background Jobs workers.
      operationId: BackgroundJobStats
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobStatisticsRequest'
        required: true
  /v1/admin/background_job/threads:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Generated
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackgroundJobThread'
      summary: Returns a list of BackgroundJobs threads
      description: Get threads from all Background Jobs workers.
      operationId: BackgroundJobThreads
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobThreadRequest'
        required: true
  /v1/background_job_handler/configuration:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobHandlerConfiguration'
      summary: Fetch the configuration of a Background Job Handler
      description: Request the configuration for a Background Job Handler
      operationId: GetBackgroundJobHandlerConfiguration
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobHandlerConfigurationRequest'
        required: true
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobHandlerConfiguration'
      summary: Update the configuration of a Background Job Handler
      description: Update the configuration for a Background Job Handler
      operationId: UpdateBackgroundJobHandlerConfiguration
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobHandlerConfigurationUpdateRequest'
        required: true
  /v1/background_job_handler/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobHandlerListResponse'
      summary: Lists the active Background Job Handlers
      description: List the active Background Job Handlers
      operationId: ListBackgroundJobHandlers
      security:
      - auth_token: []
      tags:
      - Background Jobs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundJobHandlerConfigurationRequest'
        required: true
components:
  schemas:
    BackgroundJobLogger:
      properties:
        executor:
          type: string
          description: Executor owning the logger
          example: AI
          enum:
          - AI
          - AI_AGENT
          - AI_BG
          - BROKER
          - COMPLIANCE
          - COST
          - COST_BG
          - COST_BG_CLOUD_BILLING
          - COST_BG_K8S_BILLING
          - FEATURE_FLAGS
          - GOVERNANCE
          - HEATSTACK
          - HEATSTACK_BG
          - IDENTITY
          - IDENTITY_BG
          - OPERATIONS
          - REPORT_GENERATION
          - RESOURCE_INVENTORY
          - RESOURCE_INVENTORY_BG
          - SECURITY
          x-cs-enum-type: BackgroundJobExecutor
        name:
          type: string
          description: Name of the logger
        level:
          type: string
          description: Level of a Background Job Logger
          example: CRITICAL
          enum:
          - CRITICAL
          - ERROR
          - WARNING
          - INFO
          - DEBUG
          - DEBUG_VERBOSE
          - DEBUG_OBNOXIOUS
          - NOTSET
          x-cs-enum-type: BackgroundJobLoggerLevel
        effective_level:
          type: string
          description: Level of a Background Job Logger
          example: CRITICAL
          enum:
          - CRITICAL
          - ERROR
          - WARNING
          - INFO
          - DEBUG
          - DEBUG_VERBOSE
          - DEBUG_OBNOXIOUS
          - NOTSET
          x-cs-enum-type: BackgroundJobLoggerLevel
      type: object
    BackgroundJobHandlerListResponse:
      properties:
        payload_types:
          type: array
          description: Active Background Job Handlers
          items:
            type: string
      type: object
    BackgroundJobHeapAnalysis:
      properties:
        started_at:
          type: string
          format: date-time
          description: When the Background Job was created
        completed_at:
          type: string
          format: date-time
          description: When the Background Job was created
        processes:
          type: array
          description: Process data
          items:
            $ref: '#/components/schemas/BackgroundJobHeapAnalysisProcess'
      type: object
    BackgroundJobUpdateActivationRequest:
      properties:
        job:
          description: Background Job to update
          $ref: '#/components/schemas/RecordIdentity'
        next_activation:
          type: string
          format: date-time
          description: When the Background Job will execute
      type: object
    BackgroundJobHandlerConfigurationRequest:
      properties:
        executor:
          type: string
          description: Target executor
          example: AI
          enum:
          - AI
          - AI_AGENT
          - AI_BG
          - BROKER
          - COMPLIANCE
          - COST
          - COST_BG
          - COST_BG_CLOUD_BILLING
          - COST_BG_K8S_BILLING
          - FEATURE_FLAGS
          - GOVERNANCE
          - HEATSTACK
          - HEATSTACK_BG
          - IDENTITY
          - IDENTITY_BG
          - OPERATIONS
          - REPORT_GENERATION
          - RESOURCE_INVENTORY
          - RESOURCE_INVENTORY_BG
          - SECURITY
          x-cs-enum-type: BackgroundJobExecutor
        payload_type:
          type: string
          description: Target payload type
      type: object
    BackgroundJobStatisticsResponse:
      properties:
        workers:
          type: object
          description: Map from identifier to service statistics model
          additionalProperties:
            $ref: '#/components/schemas/BackgroundJobStatistics'
      type: object
    BackgroundJobInvalidation:
      properties:
        created_at:
          type: string
          format: date-time
          description: When the invalidation message was created
        sent_at:
          type: string
          format: date-time
          description: When the invalidation message was sent
        executors:
          type: array
          description: Sources of the event
          items:
            type: string
            description: Executor of the Background Job
            example: AI
            enum:
            - AI
            - AI_AGENT
            - AI_BG
            - BROKER
            - COMPLIANCE
            - COST
            - COST_BG
            - COST_BG_CLOUD_BILLING
            - COST_BG_K8S_BILLING
            - FEATURE_FLAGS
            - GOVERNANCE
            - HEATSTACK
            - HEATSTACK_BG
            - IDENTITY
            - IDENTITY_BG
            - OPERATIONS
            - REPORT_GENERATION
            - RESOURCE_INVENTORY
            - RESOURCE_INVENTORY_BG
            - SECURITY
            x-cs-enum-type: BackgroundJobExecutor
        jobs:
          type: array
          description: Job context
          items:
            $ref: '#/components/schemas/BackgroundJobIdentityWithStatus'
        domains:
          type: array
          description: Domain context
          items:
            type: string
      type: object
    BackgroundJobBatchResponse:
      properties:
        results:
          type: object
          description: Map from identifier to response model
          additionalProperties:
            $ref: '#/components/schemas/BackgroundJob'
      type: object
    BackgroundJobBatchRequest:
      allOf:
      - $ref: '#/components/schemas/RecordIdentityBatchRequest'
      - properties:
          include_details:
            type: boolean
            description: Include payload details if true
          include_only_status:
            type: boolean
            description: Include just the status field if true
        type: object
    BackgroundJobQueryCounter:
      properties:
        identifier:
          type: string
          description: Counter identifier
        action:
          type: string
          description: Operation
        parametrized_query:
          type: object
          description: Summarized query
        query_planner:
          type: object
          description: Query Plan
        hits:
          type: integer
          description: Total number of calls
        execution_time:
          type: number
          description: Total execution time in seconds
      type: object
    BackgroundJobHandlerConfiguration:
      properties:
        max_parallel_jobs:
          type: integer
          description: Maximum number of concurrent jobs to process
        max_processes:
          type: integer
          description: Maximum number of workers to run jobs
        default_max_parallel_jobs:
          type: integer
          description: Default value for number of concurrent jobs to process
        default_max_processes:
          type: integer
          description: Default value for number of workers to run jobs
        override_expiration:
          type: string
          format: date-time
          description: Override defaults until expiration
      type: object
    BackgroundJobQueueRequest:
      properties:
        executor:
          type: string
          description: Target Executor for the job
          example: AI
          enum:
          - AI
          - AI_AGENT
          - AI_BG
          - BROKER
          - COMPLIANCE
          - COST
          - COST_BG
          - COST_BG_CLOUD_BILLING
          - COST_BG_K8S_BILLING
          - FEATURE_FLAGS
          - GOVERNANCE
          - HEATSTACK
          - HEATSTACK_BG
          - IDENTITY
          - IDENTITY_BG
          - OPERATIONS
          - REPORT_GENERATION
          - RESOURCE_INVENTORY
          - RESOURCE_INVENTORY_BG
          - SECURITY
          x-cs-enum-type: BackgroundJobExecutor
        payload:
          description: Data associated with the Background Job
          $ref: '#/components/schemas/BackgroundJobPayloadBase'
        priority:
          type: integer
          description: Priority of the Background Job
        next_activation:
          type: string
          format: date-time
          description: When the Background Job will execute
        synchronize_federation:
          type: boolean
          description: Ensure all the federation updates are sent
        check_for_queued_job:
          type: boolean
          description: Only queue if no other job is already queued. Queue if other job is already running
        check_for_running_job:
          type: boolean
          description: Only queue if no matching job is found
        queue_after_running_job:
          type: boolean
          description: Queue to run after any matching job
        auto_retries:
          type: integer
          description: Number of auto retries left for this Background Job
        auto_retry_delay:
          type: number
          description: Number of seconds to wait before a retry for this Background Job
        waiting_on:
          type: array
          description: Background Jobs this job is dependent for
          items:
            $ref: '#/components/schemas/RecordIdentity'
      type: object
    BackgroundJobHeapAnalysisModule:
      properties:
        name:
          type: string
          description: Module name
        size:
          type: integer
          description: Bytes used in module
        count:
          type: integer
          description: Object counted in module
      type: object
    BackgroundJobQueryCounterPerCaller:
      properties:
        frames:
          type: array
          description: Stack frames for the thread
          items:
            $ref: '#/components/schemas/BackgroundJobThreadFrame'
        hits:
          type: integer
          description: Total number of calls
        execution_time:
          type: number
          description: Total execution time in seconds
      type: object
    BackgroundJobUpdatePriorityRequest:
      properties:
        job:
          description: Background Job to update
          $ref: '#/components/schemas/RecordIdentity'
        priority:
          type: integer
          description: New priority of the Background Job
      type: object
    ListDetailedResponse:
      properties:
        results:
          type: array
          description: List of result identifiers
          items:
            $ref: '#/components/schemas/RecordIdentity'
        next_list_context:
          description: List context
          $ref: '#/components/schemas/ListContext'
      type: object
    BackgroundJobFilter:
      properties:
        executor:
          type: string
          description: Limit results to jobs from this executor
          example: AI
          enum:
          - AI
          - AI_AGENT
          - AI_BG
          - BROKER
          - COMPLIANCE
          - COST
          - COST_BG
          - COST_BG_CLOUD_BILLING
          - COST_BG_K8S_BILLING
          - FEATURE_FLAGS
          - GOVERNANCE
          - HEATSTACK
          - HEATSTACK_BG
          - IDENTITY
          - IDENTITY_BG
          - OPERATIONS
          - REPORT_GENERATION
          - RESOURCE_INVENTORY
          - RESOURCE_INVENTORY_BG
          - SECURITY
          x-cs-enum-type: BackgroundJobExecutor
        payload_type:
          type: string
          description: Limit results to jobs with the same payload type
        payload_identifier:
          type: string
          description: Limit results to jobs with the same payload identifier
        status:
          type: array
          description: Sets of Status values to filter on
        

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/corestack/refs/heads/main/openapi/corestack-background-jobs-api-openapi.yml