{ "opencollection": "1.0.0", "info": { "name": "PGSQL Control Plane Postgresql API", "version": "20220915" }, "items": [ { "info": { "name": "postgresql", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all backups in a compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/backups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "timeStarted", "value": "", "type": "query", "description": "The start date for getting backups. An [RFC 3339](https://tools.ietf.org/rfc/rfc3339) formatted datetime string." }, { "name": "timeEnded", "value": "", "type": "query", "description": "The end date for getting backups. An [RFC 3339](https://tools.ietf.org/rfc/rfc3339) formatted datetime string." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "backupId", "value": "", "type": "query", "description": "A unique identifier for the backup." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifier for the database system." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of backups.\n" }, { "info": { "name": "Creates a new backup.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/backups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new backup.\n" }, { "info": { "name": "Get Backup", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/backups/:backupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "A unique identifier for the backup." } ] }, "docs": "Gets a backup by identifier." }, { "info": { "name": "Update the backup identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220915/backups/:backupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "A unique identifier for the backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the backup." }, { "info": { "name": "Delete a backup.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20220915/backups/:backupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "A unique identifier for the backup." } ] }, "docs": "Deletes a backup by identifier." }, { "info": { "name": "Moves a backup into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/backups/:backupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "A unique identifier for the backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Backup Copy Request to copy back up in remote region", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/backups/:backupId/actions/copy", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "backupId", "value": "", "type": "path", "description": "A unique identifier for the backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Backup Copy Request to copy back up in remote region. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of all configurations in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/configurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`." }, { "name": "configType", "value": "", "type": "query", "description": "A filter to return only resources if their `configType` matches the given `configType`." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "dbVersion", "value": "", "type": "query", "description": "Version of the PostgreSQL database, such as 14.9." }, { "name": "shape", "value": "", "type": "query", "description": "The compute name of the shape for the configuration.\n" }, { "name": "configurationId", "value": "", "type": "query", "description": "A unique identifier for the configuration." }, { "name": "instanceOcpuCount", "value": "", "type": "query", "description": "The instance ocpu count for the configuration." }, { "name": "instanceMemorySizeInGBs", "value": "", "type": "query", "description": "The instance memory size in GBs for the configuration." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of configurations.\n" }, { "info": { "name": "Creates a new configuration.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/configurations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new configuration.\n" }, { "info": { "name": "Get a configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/configurations/:configurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "A unique identifier for the configuration." } ] }, "docs": "Gets a configuration by identifier." }, { "info": { "name": "Updates the display name or description of a configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220915/configurations/:configurationId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "A unique identifier for the configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a display name or description of the configuration.\n" }, { "info": { "name": "Delete a configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20220915/configurations/:configurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "A unique identifier for the configuration." } ] }, "docs": "Deletes a configuration by identifier." }, { "info": { "name": "Moves a configuration into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/configurations/:configurationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "A unique identifier for the configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of all database systems in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/dbSystems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifier for the database system." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of database systems.\n" }, { "info": { "name": "Creates a new database system.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new database system.\n" }, { "info": { "name": "Get DbSystem", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." }, { "name": "excludedFields", "value": "", "type": "query", "description": "A filter to exclude database configuration when this query parameter is set to OverrideDbConfig." } ] }, "docs": "Gets a database system by identifier." }, { "info": { "name": "Update the database system identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the database system." }, { "info": { "name": "Modifies the database system.", "type": "http" }, "http": { "method": "PATCH", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the database system by adding or removing database instance nodes." }, { "info": { "name": "Delete a database system.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ] }, "docs": "Deletes a database system by identifier." }, { "info": { "name": "Moves a database system into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Runs the manual failover operation.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/failover", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Runs a failover operation. Optionally, specify the desired AD for regions with three ADs." }, { "info": { "name": "Resets the database system's master password.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/resetMasterUserPassword", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resets the database system's master password." }, { "info": { "name": "Restarts the database instance node.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/restartDbInstance", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restarts the running database instance node." }, { "info": { "name": "Restore the database system.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/restore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore the database system." }, { "info": { "name": "Start the DB System.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start the DB System." }, { "info": { "name": "Stop the DB System.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ] }, "docs": "Stop the DB System." }, { "info": { "name": "Get database system connection details.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/connectionDetails", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ] }, "docs": "Gets the database system connection details." }, { "info": { "name": "Updates the database instance node.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/dbinstances/:dbInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." }, { "name": "dbInstanceId", "value": "", "type": "path", "description": "A unique identifier for the database instance node." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the database instance node." }, { "info": { "name": "Get the primary database instance node details.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/dbSystems/:dbSystemId/primaryDbInstance", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dbSystemId", "value": "", "type": "path", "description": "A unique identifier for the database system." } ] }, "docs": "Gets the primary database instance node details." }, { "info": { "name": "Gets a list of all default configurations.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/defaultConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "dbVersion", "value": "", "type": "query", "description": "Version of the PostgreSQL database, such as 14.9." }, { "name": "shape", "value": "", "type": "query", "description": "The compute name of the shape for the configuration.\n" }, { "name": "instanceOcpuCount", "value": "", "type": "query", "description": "The instance ocpu count for the configuration." }, { "name": "instanceMemorySizeInGBs", "value": "", "type": "query", "description": "The instance memory size in GBs for the configuration." }, { "name": "configurationId", "value": "", "type": "query", "description": "A unique identifier for the configuration." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of default configurations.\n" }, { "info": { "name": "Get default configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/defaultConfigurations/:defaultConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "defaultConfigurationId", "value": "", "type": "path", "description": "A unique identifier for the configuration." } ] }, "docs": "Gets a default configuration by identifier." }, { "info": { "name": "Gets a list of all possible database system shapes.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/shapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return the feature by the shape name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns the list of shapes allowed in the region." }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources if their `lifecycleState` matches the given OperationStatus." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets details of the work request with the given ID." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a (paginated) list of errors for the work request with the given ID.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220915/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a (paginated) list of logs for the work request with the given ID.\n" } ] } ], "bundled": true }