--- title: "View source for Api Creation Management - DreamFactory Wiki" source: "http://wiki.dreamfactory.com/index.php?action=edit&title=Api_Creation_Management" canonical_url: "http://wiki.dreamfactory.com/index.php?action=edit&title=Api_Creation_Management" converted_at: "2026-04-17T01:37:59.801Z" format: "markdown" converted_by: "html-to-md-ai" --- []() # View source for Api Creation Management ← [Api Creation Management](/Api_Creation_Management) [Jump to navigation](#mw-head) [Jump to search](#searchInput) You do not have permission to edit this page, for the following reason: The action you have requested is limited to users in the group: [Users](/index.php?title=DreamFactory_Wiki:Users&action=edit&redlink=1). --- You can view and copy the source of this page. {{#seo: |title=Api Creation Management - DreamFactory Documentation |title_mode=replace |canonical=https://wiki.dreamfactory.com/Api_Creation_Management |og:title=Api Creation Management |og:type=article |og:site_name=DreamFactory Documentation }} <span id="api-creation-and-management"></span> = API Creation and Management = DreamFactory uses a service-oriented architecture where every API connection is represented as a '''service'''. A service encapsulates the configuration, authentication, and endpoint definitions needed to interact with an external data source or system. Once created, each service is automatically assigned a namespace (e.g., <code>/api/v2/mysql</code>, <code>/api/v2/s3files</code>) through which all of its endpoints are accessible via DreamFactory's unified REST interface. <span id="overview-of-dreamfactorys-architecture"></span> == Overview of DreamFactory's Architecture == At its core, DreamFactory acts as a middleware layer between your application clients and your backend data sources. When you create a service, DreamFactory: # Establishes a managed connection to the target system # Auto-generates a full set of REST endpoints (for supported service types) # Applies role-based access controls, rate limiting, and logging # Produces live, interactive API documentation via the API Docs tab This means you can expose a MySQL database, an S3 file store, and a Salesforce instance through a single, consistently secured API gateway without writing any integration code. <span id="creating-a-new-api-service"></span> == Creating a New API Service == To create a new service via the Admin Console: # Navigate to '''Services''' in the left sidebar # Click the '''Create''' button (top-right) # In the '''Service Type''' dropdown, select the type of service you want to create (e.g., Database &gt; MySQL, File &gt; AWS S3, Remote Service &gt; HTTP) # Fill in the '''Info''' tab: #* '''Name''': A short, URL-safe identifier used in API paths (e.g., <code>mysql-prod</code>) #* '''Label''': A human-readable display name (e.g., "Production MySQL Database") #* '''Description''': Optional notes about the service purpose # Switch to the '''Config''' tab and provide connection-specific settings (host, port, credentials, etc.) # Click '''Save''' to create the service Once saved, the service endpoints are immediately available at <code>/api/v2/{service-name}/</code>. <syntaxhighlight lang="bash"># Example: query a table through a newly created MySQL service curl -X GET "https://your-instance.com/api/v2/mysql-prod/_table/customers?limit=10" \ -H "X-DreamFactory-API-Key: YOUR_API_KEY" \ -H "X-DreamFactory-Session-Token: YOUR_SESSION_TOKEN"</syntaxhighlight> <span id="service-types"></span> == Service Types == DreamFactory supports a wide range of service types, organized into the following categories: <span id="database-services"></span> === Database Services === Connect to relational and NoSQL databases. DreamFactory auto-generates CRUD endpoints for every table, view, and stored procedure. Supported databases include MySQL, PostgreSQL, Microsoft SQL Server, Oracle, MongoDB, Cassandra, and many more. <span id="remote-api-services"></span> === Remote API Services === Proxy and manage access to third-party HTTP and SOAP APIs. DreamFactory handles authentication headers, URL rewriting, and can apply role-based access to specific remote endpoints. * '''HTTP Service''' — Connect to any RESTful API * '''SOAP Service''' — Connect to WSDL-defined SOAP services <span id="file-storage-services"></span> === File Storage Services === Manage files stored in local or cloud storage through a unified file API: * Local file storage * AWS S3 * Azure Blob Storage * Google Cloud Storage * SFTP <span id="scripted-services"></span> === Scripted Services === Create custom API endpoints backed by server-side scripts. Supported scripting languages include PHP, Python, and Node.js. Scripted services are ideal for custom business logic, data transformation, and workflow orchestration. <span id="email-services"></span> === Email Services === Send email through SMTP, Mailgun, SparkPost, or Amazon SES via a simple REST API call. <span id="source-control-services"></span> === Source Control Services === Interact with GitHub, GitLab, and Bitbucket repositories through DreamFactory's unified API. <span id="service-namespacing-and-versioning"></span> == Service Namespacing and Versioning == Every service receives a unique namespace based on its '''Name''' field. All endpoints for the service are scoped under <code>/api/v2/{service-name}/</code>. This namespace isolation ensures there are no endpoint collisions between services, even when multiple services connect to the same type of backend. DreamFactory's API versioning is handled at the platform level (<code>/api/v2/</code>), so all services inherit the current API version automatically. <span id="managing-existing-services"></span> == Managing Existing Services == From the '''Services''' list in the Admin Console, you can: * '''Edit''' a service's configuration, credentials, or metadata * '''Deactivate''' a service without deleting it (toggle the Active flag) * '''Delete''' a service permanently (removes all associated role assignments and cached data) Service configuration changes take effect immediately — no restart is required. <span id="related-pages"></span> == Related Pages == For detailed guides on specific service types, see: * [[Getting_Started/Database|Database Connections]] — Connecting to SQL and NoSQL databases * [[docs/api-generation-and-connections/remote-http-soap|Remote HTTP and SOAP Connectors]] — Proxying external APIs * [[docs/api-generation-and-connections/file-storage|File Storage Services]] — Managing cloud and local file systems * [[docs/Scripting/scripted-apis|Scripted APIs]] — Building custom endpoints with server-side scripts * [[docs/api-generation-and-connections/email|Email Services]] — Sending email via REST [[Category:Api_Creation]] [[Category:Service_Management]] [[Category:Dreamfactory_Services]] [[Category:API]] [[Category:API]] Return to [Api Creation Management](/Api_Creation_Management). Retrieved from "[https://wiki.dreamfactory.com/Api_Creation_Management](https://wiki.dreamfactory.com/Api_Creation_Management)"