deployAPI: Deploy a Plumber API

In rsconnect: Deploy Docs, Apps, and APIs to 'Posit Connect', 'shinyapps.io', and 'RPubs'

Deploy a Plumber API

Description

Deploys an application consisting of plumber API routes. The given directory must contain a script returning a plumb object or a plumber API definition.

Usage

deployAPI(api, ...)

Arguments

api	Path to the API project directory. Must contain either entrypoint.R or plumber.R (for plumber APIs) or ⁠_server.yml⁠ (for plumber2 APIs)
...	Additional arguments to deployApp().

Details

Deploy a plumber API definition by either supplying a directory containing plumber.R (an API definition) or entrypoint.R that returns a plumb object created by plumber::plumb(). See the plumber documentation for more information. Alternatively, deploy a plumber2 API by supplying a directory containing ⁠_server.yml⁠.

See Also

Other Deployment functions: applications(), deployApp(), deployDoc(), deploySite(), deployTFModel()

rsconnect documentation built on June 26, 2025, 5:07 p.m.