Skip to main content
POST
/
functions
/
deployments
Create a function deployment
curl --request POST \
  --url https://api.nango.dev/functions/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "function",
  "integration_id": "<string>",
  "function_name": "<string>",
  "code": "<string>",
  "version": "<string>",
  "allow_destructive": true
}
'
{
  "integration_id": "<string>",
  "function_name": "<string>",
  "deployed": true,
  "deployed_functions": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "output": "<string>"
}
Requires an API key with the environment:deploy scope. Learn more about API key scopes.
Deploys TypeScript function source code to an existing integration.

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
​
type
enum<string>
required

Deploy a submitted function.

Available options:
function
​
integration_id
string
required

The integration ID (unique_key) that you created in Nango.

​
function_name
string
required

The sync or action function name.

​
function_type
enum<string>
required
Available options:
action,
sync
​
code
string
required

The TypeScript source code for the function.

Minimum string length: 1
​
version
string

Optional version tag for this deployment.

​
allow_destructive
boolean

Allow overwriting an existing standalone function with the same name.

Response

Successfully deployed the function.

​
integration_id
string
required
​
function_name
string
required
​
function_type
enum<string>
required
Available options:
action,
sync
​
deployed
boolean
required
​
deployed_functions
object[]
required
​
output
string
required

Deployment command output.