---
title: "Get a Resource Ingestion"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-dev-1/versions/d755cd20-1635-4c78-a12c-5f42a75fa20d/operations/fetch-resource-ingestion"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-dev-1/versions/d755cd20-1635-4c78-a12c-5f42a75fa20d.md

# Get a Resource Ingestion

`GET` `/integration-instances/{integrationInstanceId}/resource-ingestion`

Operation ID: `fetch-resource-ingestion`

Fetches a resource ingestion job for the given integration instance.

## Path parameters

- `integrationInstanceId` (string, required) - The `id` of the integration instance.

## Responses

- `200` - A response containing the resource ingestion status.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /integration-instances/{integrationInstanceId}/resource-ingestion:
    parameters:
      - name: integrationInstanceId
        in: path
        description: The `id` of the integration instance.
        required: true
        schema:
          type: string
          example: 004d6d17-d21f-4518-89a2-b9177cb5485c
    get:
      operationId: fetch-resource-ingestion
      summary: Get a Resource Ingestion
      description: Fetches a resource ingestion job for the given integration instance.
      responses:
        "200":
          $ref: "#/components/responses/ResourceIngestionResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Resource Ingestion
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    ResourceIngestionResponse:
      description: A response containing the resource ingestion status.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ResourceIngestionStatus"
          examples:
            Resource Ingestion Ok:
              $ref: "#/components/examples/ResourceIngestionStatusOk"
            Resource Ingestion Delayed:
              $ref: "#/components/examples/ResourceIngestionStatusDelayed"
            Resource Ingestion Halted:
              $ref: "#/components/examples/ResourceIngestionStatusHalted"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    ResourceIngestionStatus:
      description: The resource ingestion status.
      type: object
      properties:
        last_scheduled:
          description: >
            The timestamp denoting when the last ingestion job was run.

            RFC-3339 format is used with a "T" character separating date from
            time within the field value.

            A `null` value denotes that ingestion for the given integration was
            never run.
          type: string
          format: date-time
          nullable: true
        next_scheduled_at:
          description: >
            The timestamp denoting when the ingestion job is scheduled to run.

            RFC-3339 format is used with a "T" character separating date from
            time within the field value.

            A `null` value denotes that ingestion for the given integration is
            not scheduled to run.
          type: string
          format: date-time
          nullable: true
        scheduler_state:
          oneOf:
            - $ref: "#/components/schemas/ResourceSchedulerStateOk"
            - $ref: "#/components/schemas/ResourceSchedulerStateNotOk"
      additionalProperties: false
      required:
        - last_scheduled
        - next_scheduled_at
        - scheduler_state
      title: ResourceIngestionStatus
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ResourceSchedulerStateOk:
      description: Describes the resource ingestion scheduler state.
      type: object
      properties:
        status:
          type: string
          enum:
            - ok
      additionalProperties: false
      required:
        - status
      title: ResourceSchedulerStateOk
    ResourceSchedulerStateNotOk:
      description: Describes the resource ingestion scheduler state.
      type: object
      properties:
        status:
          type: string
          enum:
            - delayed
            - halted
        reason:
          description: Reason for the current resource ingestion scheduler status.
          type: string
        remediation:
          description: Possible steps which can be taken to resolve resource scheduler
            status back to "ok".
          type: string
          nullable: true
      additionalProperties: false
      required:
        - status
        - reason
        - remediation
      title: ResourceSchedulerStateNotOk
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    ResourceIngestionStatusOk:
      value:
        last_scheduled: 2025-07-01T00:00:00Z
        next_scheduled_at: 2025-07-01T00:00:00Z
        scheduler_state:
          status: ok
    ResourceIngestionStatusDelayed:
      value:
        last_scheduled: 2025-07-01T00:00:00Z
        next_scheduled_at: 2025-07-01T00:00:00Z
        scheduler_state:
          status: delayed
          reason: Integration provider is experiencing a temporary outage.
          remediation: null
    ResourceIngestionStatusHalted:
      value:
        last_scheduled: null
        next_scheduled_at: null
        scheduler_state:
          status: halted
          reason: Resource ingestion failing due to insufficient permissions.
          remediation: Reauthorize integration instance with sufficient permissions.
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
