Interop API
Get a list of actors installed in Interop Clouds for accounts visible to you. This API is used to obtain coordinates and credentials essential for interacting with Integrations and other actors.
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/actors HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Actors response
{
"data": [
null,
{
"name": "text",
"type": "connector",
"connector_type": "text",
"auth": {
"type": "text",
"client_id": "text",
"client_secret": "password",
"updated_at": "2025-07-04T16:18:06.444Z"
}
}
]
}
Get a list of Interop Clouds for accounts visible to you.
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/clouds HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Clouds response
{
"data": [
null,
{
"name": "text",
"userdata": "text",
"generation": 1
}
]
}
POST /v2/interop/clouds HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"name": "text",
"userdata": "text",
"generation": 1
}
{
"data": {
"name": "text",
"userdata": "text",
"generation": 1
}
}
Get a list of Interop Clouds matching the search criteria.
List all Clouds of a matching generation
List all Clouds with matching userdata
List all Clouds with a matching name
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/clouds/search HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Clouds response
{
"data": [
null,
{
"name": "text",
"userdata": "text",
"generation": 1
}
]
}
Find an Interop Cloud by identifier
id of the object
GET /v2/interop/clouds/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Cloud response
{
"data": {
"name": "text",
"userdata": "text",
"generation": 1
}
}
id of the object
Include actor credentials
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/clouds/{id}/actors HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Actors response
{
"data": [
null,
{
"name": "text",
"type": "connector",
"connector_type": "text",
"auth": {
"type": "text",
"client_id": "text",
"client_secret": "password",
"updated_at": "2025-07-04T16:18:06.444Z"
}
}
]
}
List all Integrations
Find an Integration by name
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/integrations HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Integrations response
{
"data": [
null,
{
"name": "text",
"title": "text",
"version": "text"
}
]
}
Create an Integration
POST /v2/interop/integrations HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"name": "text",
"title": "text",
"version": "text"
}
{
"data": {
"name": "text",
"title": "text",
"version": "text"
}
}
List the versions of an Integration. Each version is described by an Integration Blueprint.
id of the Integration
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/integrations/{id}/versions HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Integration Versions response
{
"data": [
null,
{
"version": "text",
"title": "text",
"release_state": "unspecified"
}
]
}
Create a new version of an Integration
id of the Integration
POST /v2/interop/integrations/{id}/versions HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/xml
Accept: */*
Content-Length: 6
"text"
{
"data": {
"version": "text",
"title": "text",
"release_state": "unspecified"
}
}
id of the Integration to update
version to update
PATCH /v2/interop/integrations/{id}/versions/{version} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"version": "text",
"title": "text",
"release_state": "unspecified"
}
No content
No content
id of the Integration to update
version to delete
DELETE /v2/interop/integrations/{id}/versions/{version} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
No content
id of the Integration to update
version to update
PUT /v2/interop/integrations/{id}/versions/{version}/blueprint HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/xml
Accept: */*
Content-Length: 6
"text"
IntegrationVersion response
{
"data": {
"version": "text",
"title": "text",
"release_state": "unspecified"
}
}
id of the Integration to find
GET /v2/interop/integrations/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Integration response
{
"data": {
"name": "text",
"title": "text",
"version": "text"
}
}
id of the Integration to update
PATCH /v2/interop/integrations/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"name": "text",
"title": "text",
"version": "text"
}
No content
No content
Get a list of TenantInfo
representing your licensed and authorized Integration tenants.
Optionally restrict the returned list of tenants to only those for the specified Accounts.
Optionally restrict the returned list of tenants to only those for the specified Integration or Integrations. Use this parameter when you have multiple Integrations all serviced by the same client application. When omitted, includes tenants of all Integrations owned by your account.
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/tenants HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
TenantInfos response
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"actor_id": "123e4567-e89b-12d3-a456-426614174000",
"account": null,
"cloud": null,
"integration": null,
"auth": {
"type": "text",
"client_id": "text",
"client_secret": "password",
"updated_at": "2025-07-04T16:18:06.444Z"
},
"app_auth": {
"scheme": "oauth2",
"token": "text",
"refresh_token": "text",
"client_id": "text",
"client_secret": "text",
"username": "text",
"password": "text",
"api_key": "text"
},
"lti_developer_id": "text"
}
]
}
id of the TenantInfo to find
GET /v2/interop/tenants/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
TenantInfo response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"actor_id": "123e4567-e89b-12d3-a456-426614174000",
"account": null,
"cloud": null,
"integration": null,
"auth": {
"type": "text",
"client_id": "text",
"client_secret": "password",
"updated_at": "2025-07-04T16:18:06.444Z"
},
"app_auth": {
"scheme": "oauth2",
"token": "text",
"refresh_token": "text",
"client_id": "text",
"client_secret": "text",
"username": "text",
"password": "text",
"api_key": "text"
},
"lti_developer_id": "text"
}
}
GET /v2/interop/tenant HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
TenantInfo response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"actor_id": "123e4567-e89b-12d3-a456-426614174000",
"account": null,
"cloud": null,
"integration": null,
"auth": {
"type": "text",
"client_id": "text",
"client_secret": "password",
"updated_at": "2025-07-04T16:18:06.444Z"
},
"app_auth": {
"scheme": "oauth2",
"token": "text",
"refresh_token": "text",
"client_id": "text",
"client_secret": "text",
"username": "text",
"password": "text",
"api_key": "text"
},
"lti_developer_id": "text"
}
}
GET /v2/interop/tenant/state HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
TenantState response
{
"data": {
"rollover_mode_enabled": true,
"synchronization_suspended": true,
"setup_mode_enabled": true,
"mass_change_pending": true
}
}
Get the list of ScopingSchool
s that define how to scope this tenant's repository by school
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/tenant/scoping/schools HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
ScopingSchools response
{
"data": [
{
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
]
}
true to replace existing Scoping Schools, false to append to existing Scoping Schools
true
POST /v2/interop/tenant/scoping/schools HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 255
{
"data": [
{
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
]
}
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
}
id of the ScopingSchool to find
GET /v2/interop/tenant/scoping/schools/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
ScopingSchool response
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
}
id of the Scoping School to update
PUT /v2/interop/tenant/scoping/schools/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244
{
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
ScopingSchool response
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
}
Get the list of Scoping Courses to apply to this tenant's repository
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/tenant/scoping/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
ScopingCourses response
{
"data": [
{
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"course_id": "123e4567-e89b-12d3-a456-426614174000",
"course_ref_id": "text",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
]
}
true to replace existing Scoping Courses, false to append to existing Scoping Courses
true
POST /v2/interop/tenant/scoping/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329
{
"data": [
{
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"course_id": "123e4567-e89b-12d3-a456-426614174000",
"course_ref_id": "text",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
]
}
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"course_id": "123e4567-e89b-12d3-a456-426614174000",
"course_ref_id": "text",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
}
id of the ScopingCourse to find
GET /v2/interop/tenant/scoping/courses/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
ScopingCourse response
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"course_id": "123e4567-e89b-12d3-a456-426614174000",
"course_ref_id": "text",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
}
id of the Scoping Course to update
PUT /v2/interop/tenant/scoping/courses/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 318
{
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"course_id": "123e4567-e89b-12d3-a456-426614174000",
"course_ref_id": "text",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
ScopingCourse response
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"course_id": "123e4567-e89b-12d3-a456-426614174000",
"course_ref_id": "text",
"school_id": "123e4567-e89b-12d3-a456-426614174000",
"school_ref_id": "text",
"name": "text",
"local_id": "text",
"keywords": "text",
"selected": true
}
}
The endpoint returns tenant application's authentication parameters (defined in the integration blueprint), as well as configuration options. The tenant (identified by actor authentication credentials) must be an integration. The response should be cached by driver implementations in memory.
GET /v2/interop/tenant/application HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Tenant Application Response
{
"data": {
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"tenant_id": "123e4567-e89b-12d3-a456-426614174000",
"deliver_tasks": true,
"auth_type": "unspecified",
"auth_state": "unspecified",
"options": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"auth_props": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"auth_session_id_pending": "123e4567-e89b-12d3-a456-426614174000",
"auth_message": "text",
"auth_props_pending": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"auth_state_pending": "unspecified"
}
}
Intended to be used during the authentication setup workflow (if there is authentication defined in the integration blueprint). The tenant (identified by actor authentication credentials) must be an integration. Can be updated and only when the pending auth status of the application is 'updating'). Only a subset of the Tenant Application configuration may be changed: auth message, pending auth state (can only be set to 'confirmed'/'error'), pending auth attributes.
PATCH /v2/interop/tenant/application HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"auth_message": "text",
"auth_props_pending": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"auth_state_pending": "unspecified"
}
Success
No content
Get the list of rollovers for the tenant. The tenant is identified by actor authentication credentials.
Sorting criteria. Prefix with -
for descending order.
-name
Possible values: Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/tenant/rollovers HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Rollovers response
{
"data": [
null,
{
"name": "text",
"type": "new_year",
"start_date": "2025-07-04T16:18:06.444Z",
"end_date": "2025-07-04T16:18:06.444Z",
"metadata": {
"created": null,
"updated": null
},
"status": "upcoming",
"status_change_failure_count": 1,
"failure_reason": "alreadyInRolloverMode"
}
]
}
POST /v2/interop/tenant/rollovers HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182
{
"type": "new_year",
"status": "upcoming",
"cloud_id": "123e4567-e89b-12d3-a456-426614174000",
"actor_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {
"created": null,
"updated": null
}
}
{
"data": {
"name": "text",
"type": "new_year",
"start_date": "2025-07-04T16:18:06.444Z",
"end_date": "2025-07-04T16:18:06.444Z",
"metadata": {
"created": null,
"updated": null
},
"status": "upcoming",
"status_change_failure_count": 1,
"failure_reason": "alreadyInRolloverMode"
}
}
Get the count of rollovers for the tenant. The tenant is identified by actor authentication credentials.
GET /v2/interop/tenant/rollovers/count HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Count of Rollovers
1
Get a rollover for the tenant. The tenant is identified by actor authentication credentials.
id of the rollover to query
GET /v2/interop/tenant/rollovers/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Rollover response
{
"data": {
"name": "text",
"type": "new_year",
"start_date": "2025-07-04T16:18:06.444Z",
"end_date": "2025-07-04T16:18:06.444Z",
"metadata": {
"created": null,
"updated": null
},
"status": "upcoming",
"status_change_failure_count": 1,
"failure_reason": "alreadyInRolloverMode"
}
}
id of the rollover to update
PUT /v2/interop/tenant/rollovers/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182
{
"type": "new_year",
"status": "upcoming",
"cloud_id": "123e4567-e89b-12d3-a456-426614174000",
"actor_id": "123e4567-e89b-12d3-a456-426614174000",
"metadata": {
"created": null,
"updated": null
}
}
{
"data": {
"name": "text",
"type": "new_year",
"start_date": "2025-07-04T16:18:06.444Z",
"end_date": "2025-07-04T16:18:06.444Z",
"metadata": {
"created": null,
"updated": null
},
"status": "upcoming",
"status_change_failure_count": 1,
"failure_reason": "alreadyInRolloverMode"
}
}
id of the rollover to delete
DELETE /v2/interop/tenant/rollovers/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Get the list of schedules for the tenant. The tenant is identified by actor authentication credentials.
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/tenant/schedules HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Schedules response
{
"data": [
null,
{
"type": "unspecified",
"last_executed_at": "2025-07-04T16:18:06.444Z",
"enabled": true,
"hour": 1,
"days": "text",
"metadata": null
}
]
}
Create a Schedule for the tenant identified by actor authentication credentials. Only the `hour` (understood in UTC) field is expected, only creating collection schedules is possible.
POST /v2/interop/tenant/schedules HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 10
{
"hour": 1
}
{
"data": {
"type": "unspecified",
"last_executed_at": "2025-07-04T16:18:06.444Z",
"enabled": true,
"hour": 1,
"days": "text",
"metadata": null
}
}
Only permitted for unpaused collection schedules, and if there is no pending ingestion.
id of the Schedule to run
POST /v2/interop/tenant/schedules/{id}/run HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
No content
Get the count of schedules for the tenant. The tenant is identified by actor authentication credentials.
GET /v2/interop/tenant/schedules/count HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Count of Schedules
1
id of the Schedule to find
GET /v2/interop/tenant/schedules/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Schedule response
{
"data": {
"type": "unspecified",
"last_executed_at": "2025-07-04T16:18:06.444Z",
"enabled": true,
"hour": 1,
"days": "text",
"metadata": null
}
}
Update a schedule. Only the enabled
attribute may be updated.
id of the Schedule to update
PATCH /v2/interop/tenant/schedules/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}
No content
No content
Delete a schedule.
id of the Schedule to update
DELETE /v2/interop/tenant/schedules/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
No content
Get a list of Ingestions.
Specify the page number (defaults to 0)
Specify the page_size (defaults to the maximum page size)
GET /v2/interop/ingestions HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Ingestions response
{
"data": [
null,
{
"type": "unspecified",
"state": "unspecified",
"started_at": "2025-07-04T16:18:06.444Z",
"external_import_ids": [
"text"
],
"has_pending_task": true,
"metadata": {
"scheduled": null
}
}
]
}
Get the total count of ingestions that would be returned by listIngestions
GET /v2/interop/ingestions/count HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Count of Ingestions
1
id of the Ingestion to find
GET /v2/interop/ingestions/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Ingestion response
{
"data": {
"type": "unspecified",
"state": "unspecified",
"started_at": "2025-07-04T16:18:06.444Z",
"external_import_ids": [
"text"
],
"has_pending_task": true,
"metadata": {
"scheduled": null
}
}
}
Last updated
Was this helpful?