From 54d05669db209142f828f9d98303531a69b8337f Mon Sep 17 00:00:00 2001 From: Marcin Dobrowolski Date: Thu, 9 Jul 2026 18:34:07 +0200 Subject: [PATCH] docs: add function deployment status endpoint --- docs/docs.json | 1 + docs/llms-full.txt | 10 ++ docs/llms.txt | 1 + .../http-api/functions/deployments-get.mdx | 10 ++ docs/spec.yaml | 104 ++++++++++++++++++ 5 files changed, 126 insertions(+) create mode 100644 docs/reference/backend/http-api/functions/deployments-get.mdx diff --git a/docs/docs.json b/docs/docs.json index 3c91786977..761202c299 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -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" ] }, diff --git a/docs/llms-full.txt b/docs/llms-full.txt index 1c9bdfdb8b..fbd45e0be8 100644 --- a/docs/llms-full.txt +++ b/docs/llms-full.txt @@ -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 + + + Requires an API key with the `environment:deploy` scope. [Learn more about API key scopes](/reference/backend/http-api/api-keys#scopes). + + +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 diff --git a/docs/llms.txt b/docs/llms.txt index 4727e36671..0de6d8c4f6 100644 --- a/docs/llms.txt +++ b/docs/llms.txt @@ -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) diff --git a/docs/reference/backend/http-api/functions/deployments-get.mdx b/docs/reference/backend/http-api/functions/deployments-get.mdx new file mode 100644 index 0000000000..32a4da9fab --- /dev/null +++ b/docs/reference/backend/http-api/functions/deployments-get.mdx @@ -0,0 +1,10 @@ +--- +title: 'Get a function deployment' +openapi: 'GET /functions/deployments/{id}' +--- + + + Requires an API key with the `environment:deploy` scope. [Learn more about API key scopes](/reference/backend/http-api/api-keys#scopes). + + +Returns the status and result of an asynchronous function deployment. diff --git a/docs/spec.yaml b/docs/spec.yaml index 7fc8212280..701ea0e087 100644 --- a/docs/spec.yaml +++ b/docs/spec.yaml @@ -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 @@ -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