Skip to Content

Use endpoints for deployments on Jitterbit App Builder

Introduction

You can use REST endpoints to retrieve the details of releases, to start building them, or to get information about the target environment:

Prerequisites

  • You must generate an API key on the server, and be a member of the Deployment role.

release endpoint

Note

This endpoint is available for App Builder 4.52 and later.

With this endpoint, you can do the following:

  • GET: Retrieve release information for a specified solution or release.

  • POST: Build a release.

Responses can contain the following fields:

  • releaseId: Release identifier.

  • solutionId: Solution identifier.

  • name: Release name (corresponds to the solution name).

  • version: Developer-supplied version number.

  • releaseNotes: Developer-supplied release notes.

  • releaseDate: Developer-supplied release date.

  • status: Read-only build status. Values include the following:

    • Queued
    • Building
    • Built
    • Failed

  • fileName: Package (LP) file name.

  • file: Base64-encoded package file.

  • snapshot: Flag to indicate if a snapshot should be taken before the release is built.

GET /rest/v1/vinyl-deploy/release?solutionId={{ solutionId }}

Retrieve the specified solution releases.

  • solutionId: Solution identifier.
Example 
GET https://example.com/rest/v1/vinyl-deploy/release?solutionId=4df8b502-56d0-498a-98de-511b4134ee3c
Accept: application/json
X-Api-Key: abcdef.1234567890


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "count": null,
  "items": [
    {
      "releaseId": "1e3690ef-afff-4a4a-919e-01e100b259d7",
      "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
      "name": "Customers",
      "version": "1.0",
      "releaseNotes": "Added company name.",
      "releaseDate": "2025-11-06T00:00:00"
    },
    {
      "releaseId": "ad16337f-d677-4527-84f1-651bd928238a",
      "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
      "name": "Customers",
      "version": "1.0",
      "releaseNotes": null,
      "releaseDate": "2025-10-27T00:00:00"
    }
  ],
  "message": null,
  "validations": [],
  "status": 200
}

GET /rest/v1/vinyl-deploy/release/{{ releaseId }}

Retrieve the information for a specific release, including the base64-encoded package file.

  • releaseId: Release identifier.
Example 
GET https://example.com/rest/v1/vinyl-deploy/release/1e3690ef-afff-4a4a-919e-01e100b259d7?solutionId=4df8b502-56d0-498a-98de-511b4134ee3c
Accept: application/json
X-Api-Key:  abcdef.1234567890


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "These are my release notes.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "built",
    "fileName": "Customers-1.0.LP",
    "file": "...Base64-encoded file...",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

POST /rest/v1/vinyl-deploy/release

Build a release.

Important

This is a synchronous (blocking) operation: the server does not respond until the build completes, successfully or otherwise.

Example 
POST https://example.com/rest/v1/vinyl-deploy/release
Content-Type: application/json
X-Api-Key:  abcdef.1234567890

{
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "releaseNotes": "Added company name.",
    "snapshot": false
}


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "These are my release notes.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "built",
    "fileName": "Customers-1.0.LP",
    "file": "...Base64-encoded file...",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

release-queue endpoint

Note

This endpoint is available for App Builder 4.52 and later.

Submit a build request to the queue.

Responses can contain the following fields:

  • releaseId: Release identifier.

  • solutionId: Solution identifier.

  • name: Release name (corresponds to the solution name).

  • version: Developer-supplied version.

  • releaseNotes: Developer-supplied release notes.

  • releaseDate: Developer-supplied release date.

  • status: Build status. Read-only. Values include queued, building, built and failed.

  • snapshot: Flag to indicate if a snapshot should be taken before the release is built.

POST /rest/v1/vinyl-deploy/release-queue

Queue a release build.

Important

This is an asynchronous, non-blocking operation. The server returns immediately; the build takes place in the background. Developers must poll for the current status to determine when the build has completed.

Example 
POST https://example.com/rest/v1/vinyl-deploy/release-queue
Content-Type: application/json
X-Api-Key:  abcdef.1234567890

{
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "releaseNotes": "Added company name.",
    "snapshot": false
}


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "Added company name.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "queued",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

GET /rest/v1/vinyl-deploy/release-queue/{{ releaseId }}?solutionId={{ solutionId }}

Retrieve the current status of a queued release.

  • releaseId: Release identifier.

  • solutionId: Solution identifier.

Example 
GET https://example.com/rest/v1/vinyl-deploy/release-queue/9b5211e1-402a-4f04-b87d-33f28a55987a
Content-Type: application/json
X-Api-Key:  abcdef.1234567890


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "Added company name.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "built",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

metadata endpoint

Note

This endpoint is available for App Builder 4.54 and later.

With this endpoint, you can do the following:

  • GET: Retrieve the environment configuration.

Responses can contain the following fields:

  • environmentId: Environment identifier.

  • name: Environment name, e.g. QA or Production.

  • url: Canonical environment root URL.

  • supportsDeployment: Indicates whether the environment supports deployments.

  • supportsInstallOnDeploy: Indicates whether the environment allows packages to be installed during the deployment process.

  • authenticationType: Denotes the required authentication type:

    • api_key

    • http_basic_auth

    • auth_server

GET /rest/v1/vinyl-deploy/metadata

Retrieve the environment configuration.