RailwayDocs

Manage Services with the Public API

Here are examples to help you manage your services using the Public API.

Get a service

Fetch a service by ID:

Variables

Get a service instance

Get detailed service configuration for a specific environment:

Variables

Create a service

From a GitHub repository

Variables

From a Docker image

Variables

Empty service (no source)

Create an empty service that you can configure later:

Variables

Update a service

Update service name or icon:

Variables

Update service instance settings

Update build/deploy settings for a service in a specific environment. Click "Additional options" to see all available settings:

Variables

Connect a service to a repo

Connect an existing service to a GitHub repository:

Variables

Disconnect a service from a repo

Variables

Deploy a service

Trigger a new deployment for a service:

Variables

This returns the deployment ID.

Redeploy a service

Redeploy the latest deployment:

Variables

Get resource limits

Get the resource limits for a service instance (returns a JSON object):

Variables

Delete a service

Variables