{ "opencollection": "1.0.0", "info": { "name": "Aptible API v1 Databases API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Databases", "type": "folder" }, "items": [ { "info": { "name": "list databases", "type": "http" }, "http": { "method": "GET", "url": "{baseUrl}/accounts/:account_id/databases", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "account_id" }, { "name": "page", "value": "", "type": "query", "description": "Current page of paginated results" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results to return per page" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ] }, "docs": "Returns a paginated list of databases belonging to the specified account." }, { "info": { "name": "create database", "type": "http" }, "http": { "method": "POST", "url": "{baseUrl}/accounts/:account_id/databases", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "account_id" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new database within the specified account." }, { "info": { "name": "list databases", "type": "http" }, "http": { "method": "GET", "url": "{baseUrl}/databases/:database_id/dependents", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "database_id", "value": "", "type": "path", "description": "database_id" }, { "name": "page", "value": "", "type": "query", "description": "Current page of paginated results" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results to return per page" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ] }, "docs": "Returns a paginated list of replica databases for the specified database." }, { "info": { "name": "list databases", "type": "http" }, "http": { "method": "GET", "url": "{baseUrl}/databases", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Current page of paginated results" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results to return per page" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ] }, "docs": "Returns a paginated list of all databases." }, { "info": { "name": "show database", "type": "http" }, "http": { "method": "GET", "url": "{baseUrl}/databases/:id", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ] }, "docs": "Returns the details of a specific database by ID." }, { "info": { "name": "update database", "type": "http" }, "http": { "method": "PUT", "url": "{baseUrl}/databases/:id", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a database's attributes." }, { "info": { "name": "update database", "type": "http" }, "http": { "method": "PATCH", "url": "{baseUrl}/databases/:id", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially updates a database's attributes." }, { "info": { "name": "delete database", "type": "http" }, "http": { "method": "DELETE", "url": "{baseUrl}/databases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Deletes a database by ID." }, { "info": { "name": "find database by handle", "type": "http" }, "http": { "method": "GET", "url": "{baseUrl}/find/database", "headers": [ { "name": "Prefer", "value": "" } ], "params": [ { "name": "handle", "value": "", "type": "query", "description": "database handle" }, { "name": "environment", "value": "", "type": "query", "description": "account handle to disambiguate when multiple databases share the same handle" }, { "name": "no_embed", "value": "", "type": "query", "description": "When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present." } ] }, "docs": "Returns the database matching the specified handle." } ] } ], "bundled": true }