# Oracle Database Environment API

**Canonical:** https://apis.io/apis/oracle-database/oracle-database-environment-api/  
**Provider:** Oracle Database — https://apis.io/providers/oracle-database/  
**Documentation:** https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/

Oracle Database Environment API is one of 39 APIs that [Oracle Database](https://apis.io/providers/oracle-database/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Environment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

ORDS Database API services for the Oracle Database installation: Oracle Homes, databases in a home, DBCA jobs and DBCA templates. Available on Unix-based operating systems only.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/environment/databases/` | Get a list of the databases defined in the default Oracle Home |
| POST | `/environment/databases/` | Create a new database in the default Oracle Home |
| GET | `/environment/databases/{databaseName}` | Get a specific database defined in the default Oracle Home |
| GET | `/environment/dbca/jobs/` | Get a list of the DBCA jobs created through ORDS Database API in the default… |
| POST | `/environment/dbca/jobs/` | Create a new DBCA job in the default Oracle Home |
| GET | `/environment/dbca/jobs/{jobId}/` | Get a specified DBCA jobs created through ORDS Database API in the default… |
| DELETE | `/environment/dbca/jobs/{jobId}/` | Delete the specified DBCA job in the default Oracle Home |
| GET | `/environment/dbca/jobs/{jobId}/log` | Get the DBCA log file content for a specified DBCA jobs created through ORDS… |
| GET | `/environment/dbca/templates/` | Get a list of the DBCA database templates defined in the default Oracle Home |
| GET | `/environment/dbca/templates/{filename}` | Get a specific database template file in the default Oracle Home |
| GET | `/environment/homes/` | Get database Oracle Homes |
| GET | `/environment/homes/{homeName}/databases/` | Get a list of the databases defined in an Oracle Home |
| POST | `/environment/homes/{homeName}/databases/` | Create a new database in the specified Oracle Home |
| GET | `/environment/homes/{homeName}/databases/{databaseName}` | Get a specific database defined in a specific Oracle Home |
| GET | `/environment/homes/{homeName}/dbca/jobs/` | Get a list of the DBCA jobs created through ORDS Database API in the Oracle Home |
| POST | `/environment/homes/{homeName}/dbca/jobs/` | Create a new DBCA job in the Oracle Home |
| GET | `/environment/homes/{homeName}/dbca/jobs/{jobId}/` | Get a specified DBCA jobs created through ORDS Database API in the specified… |
| DELETE | `/environment/homes/{homeName}/dbca/jobs/{jobId}/` | Delete the specified DBCA job in the default Oracle Home |
| GET | `/environment/homes/{homeName}/dbca/jobs/{jobId}/log` | Get the DBCA log file content for a specified DBCA jobs created through ORDS… |
| GET | `/environment/homes/{homeName}/dbca/templates/` | Get a list of the DBCA database templates defined in an Oracle Home |
| GET | `/environment/homes/{homeName}/dbca/templates/{filename}` | Get a specific database template file in a specific Oracle Home |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/openapi/oracle-database-environment-api-openapi.yml
- **Documentation** — https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/26.1/orrst/index.html
- **APIReference** — https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/26.1/orrst/rest-endpoints.html

## Other Oracle Database APIs (12)

- [Oracle Database API for MongoDB](https://apis.io/apis/oracle-database/oracle-database-api-for-mongodb/)
- [Oracle Database JDBC](https://apis.io/apis/oracle-database/oracle-database-jdbc/)
- [Oracle Call Interface (OCI)](https://apis.io/apis/oracle-database/oracle-call-interface-oci/)
- [Oracle SQL Developer REST API](https://apis.io/apis/oracle-database/oracle-sql-developer-rest-api/)
- [Oracle Transactional Event Queues (TxEventQ)](https://apis.io/apis/oracle-database/oracle-transactional-event-queues-txeventq/)
- [Oracle Database APEX API](https://apis.io/apis/oracle-database/oracle-database-apex-api/)
- [Oracle Database Autonomous Databases API](https://apis.io/apis/oracle-database/oracle-database-autonomous-databases-api/)
- [Oracle Database Backups API](https://apis.io/apis/oracle-database/oracle-database-backups-api/)
- [Oracle Database Bulk Operations API](https://apis.io/apis/oracle-database/oracle-database-bulk-operations-api/)
- [Oracle Database Collections API](https://apis.io/apis/oracle-database/oracle-database-collections-api/)
- [Oracle Database Data Dictionary API](https://apis.io/apis/oracle-database/oracle-database-data-dictionary-api/)
- [Oracle Database Data Guard API](https://apis.io/apis/oracle-database/oracle-database-data-guard-api/)

## Tags

Environment

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/oracle-database/oracle-database-environment-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/oracle-database/.