How to Add a Service to your Project

Updated March 17, 2026 07:06

Adding a new service to your project is done in the project configuration file (.upsun/config.yaml) in your Git repository.

Adding the service

Configure your service by adding a section in this format to the project configuration file:

.upsun/config.yaml

services:
  <SERVICE_NAME>:
    type: <SERVICE_TYPE>:<VERSION>
    # Other options...

Many services have additional options that you can configure here. For more information, see the relevant service's page in our documentation.

Granting your apps access to the service

Once a service has been added, you can provide your apps access to it by defining a relationship. To add a relationship, add a section similar to the following example under the app's section in the project configuration file:

.upsun/config.yaml

    relationships:
      <RELATIONSHIP>:
        service: <SERVICE_NAME>
        endpoint: <SERVICE_TYPE>

Note: renaming a service is essentially removing old service and adding a new one, resulting in complete data loss for the old service.