For the complete documentation index, see llms.txt. This page is also available as Markdown.

Git Sync via API

Pull the latest rules, workflows and other entities from your connected remote Git repository into a workspace branch. Use it to bring a branch up to date from a CI/CD pipeline or script, without opening the Nected UI.

This replaces the deprecated POST /dev/remote/pull endpoint (Pull Remote Data). Use POST /dev/v1/remote/pull for all new integrations.

Pull remote data (Git Sync)

post

Starts a pull from your remote source into the workspace branch. The pull runs in the background, so the response returns straight away with a taskId and the current taskState.

The request needs no body. Authenticate with Nected-API-Key, and send Nected-Branch to choose the branch to pull into.

Authorizations
Nected-API-KeystringRequired

Your Nected API key.

Header parameters
Nected-BranchstringOptional

Name of the workspace branch to pull into, for example main.

Responses
200

The pull has started.

application/json

Standard API response wrapper.

codestringOptional
messagestringOptional
pageNointegerOptional
pageSizeintegerOptional
totalCountintegerOptional
totalPagesintegerOptional
post/dev/v1/remote/pull
POST /dev/v1/remote/pull HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Accept: */*
{
  "code": "",
  "message": "",
  "data": {
    "taskId": "<TASK_ID>",
    "taskState": "pending"
  }
}

Good to know

  • The pull runs in the background. The response returns right away with a taskId and a taskState, and the pull keeps running after that. Save the taskId so you can identify the pull.

  • Task states: pending (queued), in-progress (running), completed (finished successfully) and failed (stopped with an error).

  • Choose the branch with the Nected-Branch header. The branch must already exist in your workspace, and you need permission to pull on it.

Last updated