{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Object Store Services API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Object Store Services", "type": "folder" }, "items": [ { "info": { "name": "Add a follower", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/storageServices/:id/followers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Storage Service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user identified by `userId` as followed of this Storage service" }, { "info": { "name": "Add test connection result", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/storageServices/:id/testConnectionResult", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add test connection result to the service." }, { "info": { "name": "List storage services", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/storageServices", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "domain", "value": "", "type": "query", "description": "Filter services by domain" }, { "name": "limit", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of storage services before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of storage services after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of storage services." }, { "info": { "name": "Create storage service", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/services/storageServices", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new storage service." }, { "info": { "name": "Update storage service", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/storageServices", "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing or create a new storage service." }, { "info": { "name": "Update an storage service by FQN", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/services/storageServices/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the storage service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing storage service using JsonPatch by FQN." }, { "info": { "name": "Delete an StorageService by fully qualified name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/storageServices/name/:fqn", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "fqn", "value": "", "type": "path", "description": "Name of the StorageService" } ] }, "docs": "Delete an StorageService by `fullyQualifiedName`." }, { "info": { "name": "Get an storage service", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/storageServices/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "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." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get an storage service by `id`." }, { "info": { "name": "Update an storage service", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/services/storageServices/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing storage service using JsonPatch." }, { "info": { "name": "Delete an storage service", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/storageServices/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the storage service" } ] }, "docs": "Delete an storage services. If containers belong the service, it can't be deleted." }, { "info": { "name": "Asynchronously delete an storage service", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/storageServices/async/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the storage service" } ] }, "docs": "Asynchronously delete an storage services. If containers belong the service, it can't be deleted." }, { "info": { "name": "Remove a follower", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/storageServices/:id/followers/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" }, { "name": "userId", "value": "", "type": "path", "description": "Id of the user being removed as follower" } ] }, "docs": "Remove the user identified `userId` as a follower of the entity." }, { "info": { "name": "Get storage service by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/storageServices/name/:name", "params": [ { "name": "name", "value": "", "type": "path" }, { "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." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get a storage service by the service `name`." }, { "info": { "name": "Get a version of the storage service", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/storageServices/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "storage service Id" }, { "name": "version", "value": "", "type": "path", "description": "storage service version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the storage service by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/storageServices/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 storage service versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/storageServices/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "storage service Id" } ] }, "docs": "Get a list of all the versions of an storage service identified by `id`" }, { "info": { "name": "Restore a soft deleted StorageService.", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/storageServices/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted StorageService." } ] } ], "bundled": true }