{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Bots API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Bots", "type": "folder" }, "items": [ { "info": { "name": "List bots", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bots", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of Bot before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of Bot after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of Bot." }, { "info": { "name": "Create a bot", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/bots", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new bot." }, { "info": { "name": "Create or update a bot", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/bots", "body": { "type": "json", "data": "{}" } }, "docs": "Create a bot, if it does not exist. If a bot already exists, update the bot." }, { "info": { "name": "Get a bot by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bots/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the bot" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a bot by `name`." }, { "info": { "name": "Delete a bot by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/bots/name/:name", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "name", "value": "", "type": "path", "description": "Name of the bot" } ] }, "docs": "Delete a bot by `name`." }, { "info": { "name": "Get a bot by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bots/:id", "params": [ { "name": "include", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "Id of the bot" } ] }, "docs": "Get a bot by `Id`." }, { "info": { "name": "Update a bot", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/bots/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the bot" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing bot using JsonPatch." }, { "info": { "name": "Delete a bot by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/bots/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the bot" } ] }, "docs": "Delete a bot by `Id`." }, { "info": { "name": "Asynchronously delete a bot by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/bots/async/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the bot" } ] }, "docs": "Asynchronously delete a bot by `Id`." }, { "info": { "name": "Get a version of the bot", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bots/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the bot" }, { "name": "version", "value": "", "type": "path", "description": "bot version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the bot by given `Id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bots/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 bot versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/bots/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the bot" } ] }, "docs": "Get a list of all the versions of a bot identified by `Id`" }, { "info": { "name": "Update a bot by name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/bots/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the bot" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing bot using JsonPatch." }, { "info": { "name": "Restore a soft deleted bot", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/bots/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted bot." } ] } ], "bundled": true }