{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Apps API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Apps", "type": "folder" }, "items": [ { "info": { "name": "List application", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/marketplace", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of installed applications returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of tests before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of tests after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of applications. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Create a Application", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps/marketplace", "body": { "type": "json", "data": "{}" } }, "docs": "Create a application" }, { "info": { "name": "Create Or Update App", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/apps/marketplace", "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update App, it it does not exist or update an existing KPI." }, { "info": { "name": "Get a App by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/marketplace/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a App by `name`." }, { "info": { "name": "Delete a App by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/apps/marketplace/name/:name", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "name", "value": "", "type": "path", "description": "Name of the App" } ] }, "docs": "Delete a App by `name`." }, { "info": { "name": "Get a app by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/marketplace/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the App" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a app by `Id`." }, { "info": { "name": "Updates a App", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/apps/marketplace/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the App" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing App using JsonPatch." }, { "info": { "name": "Delete a App by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/apps/marketplace/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the App" } ] }, "docs": "Delete a App by `Id`." }, { "info": { "name": "Asynchronously delete a App by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/apps/marketplace/async/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the App" } ] }, "docs": "Asynchronously delete a App by `Id`." }, { "info": { "name": "Get a version of the App", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/marketplace/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the App" }, { "name": "version", "value": "", "type": "path", "description": "KPI version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the App by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/marketplace/history", "params": [ { "name": "startTs", "value": "", "type": "query", "description": "Start timestamp in milliseconds since epoch" }, { "name": "endTs", "value": "", "type": "query", "description": "End timestamp in milliseconds since epoch" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of entity returned (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of entity versions before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of entity versions after this cursor" } ] }, "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. " }, { "info": { "name": "List Installed Application versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/marketplace/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the app" } ] }, "docs": "Get a list of all the versions of a application identified by `id`" }, { "info": { "name": "Updates an App by name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/apps/marketplace/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the App" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing App using JsonPatch." }, { "info": { "name": "Restore a soft deleted KPI", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/apps/marketplace/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted App." }, { "info": { "name": "Configure an Application", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps/configure/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" } ] }, "docs": "Schedule a application to be run on demand." }, { "info": { "name": "List installed application", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of installed applications returned. (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of tests before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of tests after this cursor" }, { "name": "agentType", "value": "", "type": "query", "description": "Filter by agent type(s). Can be a single value or comma-separated values" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of applications. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Create a Application", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps", "body": { "type": "json", "data": "{}" } }, "docs": "Create a application" }, { "info": { "name": "Create Or Update App", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/apps", "body": { "type": "json", "data": "{}" } }, "docs": "Create or Update App, it it does not exist or update an existing KPI." }, { "info": { "name": "Get a App by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a App by `name`." }, { "info": { "name": "Delete a App by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/apps/name/:name", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "name", "value": "", "type": "path", "description": "Name of the App" } ] }, "docs": "Delete a App by `name`." }, { "info": { "name": "Get a app by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the App" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a app by `Id`." }, { "info": { "name": "Updates a App", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/apps/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the App" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing App using JsonPatch." }, { "info": { "name": "Delete a App by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/apps/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the App" } ] }, "docs": "Delete a App by `Id`." }, { "info": { "name": "Asynchronously delete a App by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/apps/async/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the App" } ] }, "docs": "Asynchronously delete a App by `Id`." }, { "info": { "name": "Deploy App to Quartz or Ingestion", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps/deploy/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" } ] }, "docs": "Deploy App to Quartz or Ingestion." }, { "info": { "name": "Retrieve all logs from last ingestion pipeline run for the application", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/name/:name/logs", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "after", "value": "", "type": "query", "description": "Returns log chunk after this cursor" }, { "name": "runId", "value": "", "type": "query", "description": "Pipeline run ID to fetch logs for a specific run. If not provided, returns logs for the latest run." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of lines to return (only applies to streamable logs)" } ] }, "docs": "Get all logs from last ingestion pipeline run by `Id`." }, { "info": { "name": "Get a version of the App", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the App" }, { "name": "version", "value": "", "type": "path", "description": "App version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the App by given `id`" }, { "info": { "name": "List Entity Reference for installed application", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/installed" }, "docs": "Get a list of applications " }, { "info": { "name": "List App Extension data", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/name/:name/extension", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "limit", "value": "", "type": "query", "description": "Limit records. (1 to 1000000, default = 10)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset records. (0 to 1000000, default = 0)" }, { "name": "startTs", "value": "", "type": "query", "description": "Filter pipeline status after the given start timestamp" }, { "name": "extensionType", "value": "", "type": "query", "description": "Get the extension type" }, { "name": "byName", "value": "", "type": "query", "description": "List extensions by name instead of id" } ] }, "docs": "Get a list of applications Extension data. Use cursor-based pagination to limit the number entries in the list using `offset` query params." }, { "info": { "name": "List App Run Records", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/name/:name/status", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "limit", "value": "", "type": "query", "description": "Limit records. (1 to 1000000, default = 10)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset records. (0 to 1000000, default = 0)" }, { "name": "startTs", "value": "", "type": "query", "description": "Filter pipeline status after the given start timestamp" }, { "name": "endTs", "value": "", "type": "query", "description": "Filter pipeline status before the given end timestamp" } ] }, "docs": "Get a list of applications Run Record. Use cursor-based pagination to limit the number entries in the list using `offset` query params." }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/history", "params": [ { "name": "startTs", "value": "", "type": "query", "description": "Start timestamp in milliseconds since epoch" }, { "name": "endTs", "value": "", "type": "query", "description": "End timestamp in milliseconds since epoch" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of entity returned (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of entity versions before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of entity versions after this cursor" } ] }, "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. " }, { "info": { "name": "Get Latest App Run Record", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/name/:name/runs/latest", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "after", "value": "", "type": "query", "description": "Returns log chunk after this cursor" } ] }, "docs": "Get a latest applications Run Record." }, { "info": { "name": "List Search Index Retry Queue", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/name/:name/live-indexing-queue", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "limit", "value": "", "type": "query", "description": "Limit records. (1 to 1000, default = 10)" }, { "name": "offset", "value": "", "type": "query", "description": "Offset records. (0 to 1000000, default = 0)" } ] }, "docs": "Get the current live indexing retry queue entries for the SearchIndexingApplication." }, { "info": { "name": "List Installed Application versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/apps/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the app" } ] }, "docs": "Get a list of all the versions of a application identified by `id`" }, { "info": { "name": "Updates a App by name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/apps/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the App" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing App using JsonPatch." }, { "info": { "name": "Restore a soft deleted KPI", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/apps/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted App." }, { "info": { "name": "Schedule an Application", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps/schedule/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" } ] }, "docs": "Schedule a application to be run on demand." }, { "info": { "name": "Stop a Application run", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps/stop/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" }, { "name": "runId", "value": "", "type": "query", "description": "Pipeline run ID to stop a specific run" } ] }, "docs": "Stop a application run by name." }, { "info": { "name": "Trigger an Application run", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/apps/trigger/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Trigger a Application run by name." } ] } ], "bundled": true }