Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -810,6 +810,7 @@
"reference/backend/http-api/functions/dryruns-create",
"reference/backend/http-api/functions/dryruns-get",
"reference/backend/http-api/functions/deployments",
"reference/backend/http-api/functions/deployments-get",
"reference/backend/http-api/scripts/config"
]
},
Expand Down
10 changes: 10 additions & 0 deletions docs/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9199,6 +9199,16 @@ Source: https://nango.dev/docs/reference/backend/http-api/functions/deployments.

Deploys a function to an existing integration: either submitted TypeScript source code (`type: function`) or a template from the provider catalog (`type: template`).

## Get a function deployment

Source: https://nango.dev/docs/reference/backend/http-api/functions/deployments-get.md

<Info>
Requires an API key with the `environment:deploy` scope. [Learn more about API key scopes](/reference/backend/http-api/api-keys#scopes).
</Info>

Returns the status and result of an asynchronous function deployment.

## Get integration functions config

Source: https://nango.dev/docs/reference/backend/http-api/scripts/config.md
Expand Down
1 change: 1 addition & 0 deletions docs/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ Use provider URLs by replacing `{slug}` with a slug from the API catalog:
- [Backend: HTTP API: Functions: Dry run a function](https://nango.dev/docs/reference/backend/http-api/functions/dryruns-create.md)
- [Backend: HTTP API: Functions: Get dry run results](https://nango.dev/docs/reference/backend/http-api/functions/dryruns-get.md)
- [Backend: HTTP API: Functions: Create a function deployment](https://nango.dev/docs/reference/backend/http-api/functions/deployments.md)
- [Backend: HTTP API: Functions: Get a function deployment](https://nango.dev/docs/reference/backend/http-api/functions/deployments-get.md)
- [Backend: HTTP API: Functions: Get integration functions config](https://nango.dev/docs/reference/backend/http-api/scripts/config.md)
- [Backend: HTTP API: Syncs: Get records](https://nango.dev/docs/reference/backend/http-api/sync/records-list.md)
- [Backend: HTTP API: Syncs: Prune records](https://nango.dev/docs/reference/backend/http-api/sync/prune-records.md)
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/backend/http-api/functions/deployments-get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Get a function deployment'
openapi: 'GET /functions/deployments/{id}'
---

<Info>
Requires an API key with the `environment:deploy` scope. [Learn more about API key scopes](/reference/backend/http-api/api-keys#scopes).
</Info>

Returns the status and result of an asynchronous function deployment.
104 changes: 104 additions & 0 deletions docs/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1815,6 +1815,34 @@ paths:
'504':
$ref: '#/components/responses/GatewayTimeout'

/functions/deployments/{id}:
get:
operationId: getFunctionDeployment
summary: Get a function deployment
description: Returns the status and result of an asynchronous function deployment.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Successfully retrieved the deployment.
content:
application/json:
schema:
$ref: '#/components/schemas/FunctionDeploymentResultResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'

/records:
get:
summary: Get synced records
Expand Down Expand Up @@ -3551,6 +3579,82 @@ components:
type: string
format: date-time

FunctionDeploymentResultResponse:
type: object
additionalProperties: false
required:
- id
- status
- integration_id
- function_name
- function_type
- created_at
- updated_at
properties:
id:
type: string
format: uuid
status:
type: string
enum: [waiting, running, success, failed]
description: The status of the function deployment.
integration_id:
type: string
description: The integration ID (unique_key) that you created in Nango.
function_name:
type: string
description: The sync or action function name.
function_type:
$ref: '#/components/schemas/RunnableFunctionType'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
started_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
duration_ms:
type: integer
minimum: 0
deployed:
type: boolean
description: Whether the deployment updated any functions.
deployed_functions:
type: array
items:
type: object
additionalProperties: false
required:
- name
- version
properties:
name:
type: string
version:
type: string
description: Functions updated by the deployment.
output:
type: string
description: Deployment command output.
error:
type: object
additionalProperties: false
required:
- code
- message
properties:
code:
type: string
message:
type: string
payload:
description: Optional error payload.

FunctionDeployResponse:
type: object
additionalProperties: false
Expand Down
Loading