API Cloud Link Schemas
Last Updated: April 07, 2026
Use the API schemas in this section as a reference when configuring API Cloud Link for Vasion Output. For detailed information about Vasion Output, see Vasion Output.
You need to configure settings for API Cloud Link in two places:
- In the Vasion Print Admin Console.
- Inside your source application to make RESTful API calls for submitting print jobs or batch print requests.
API Cloud Link supports API calls for cloud tools. For more details refer to Configure API Cloud Link.
Supported API Calls
Once configured, your source application can make the following RESTful API calls:
- Printer Synchronization List: Collects a list of printers from your Vasion instance to populate the list into applications rather than manually adding or importing them.
- Print Job Request: Sends the file to be printed to the API Cloud Link gateway along with metadata about the file that dictates where the job is sent, as well as color, duplex, and other finishing options.
- Batch Open Request: Ensures certain files are printed in a specific order. This request is used to begin the batch printing process and includes an ordered list of print job Universally Unique Identifier (UUID) and files.
- Batch Close Request: Sent after a batch open request, and all associated files have been sent to the API Cloud Link. Once a batch is closed, the files with UUIDs listed in the initial batch open request will be printed in the order the UUIDs were listed in the initial request.
- Print Job Status: After a job has been printed, or if it failed to print, the API Cloud Link responds back to the customer application requests with the status of the print job associated to the UUID.
API Schemas
The following topics include the recommended schema for configuring API Cloud Link.
Troubleshooting Help
printapi printstatusapi printersynclist printstatuscloudapi printcloudapi srs-printersynclist srs-printjobrequest srs-printstatusapi fed-printersynclist fed-printstatusapi fed-printjobrequest
In some setups, external applications may need to reach the Vasion OutputService Client using a DNS name that resolves to an external IP address. However, this can cause issues the following issues:
- The Service Client cannot resolve the DNS name to its internal IP address.
- External DNS resolution conflicts with internal requirements.
Check if the Service Client can resolve the DNS name to its internal IP address. If the DNS name doesn't resolve correctly, you may need to modify the hosts file. See Troubleshoot DNS Resolution for Output Automation-Service Client
Ensure that the DNS name in the UI matches the one in the certificate used by the Service Client.
The API Print Service can send documents to the printer via LPR and RAW protocols.
The API Print Service runs on the Vasion Output Service on a Windows or Debian Linux server either on-premise or in your cloud instance. This allows the API Print Service to reach your source application and printers unless Off-Network Print is utilized. This back-end configuration is flexible to your environment’s requirements to function seamlessly with your existing systems and processes.
The API Print Service accepts and processes print jobs concurrently for improved scalability and speed. Documents sent to the same printer will be printed in sequential order.
The Service’s maximum capacity depends on the hardware it is running on and network connection speeds. If capacity is reached, additional service clients can be utilized with a load balancer to distribute traffic to a highly available partner service client.
Vasion Output was built to scale with high volumes of input in mind and has been shown to process high volumes of documents in less than a second. Various factors, like job size, sequential printing, and hardware capacity, can affect print job speed.
Your documents sent to the API Print Service pass within a Transport Layer Security (TLS) tunnel to the HTTPS server. Files are also encrypted, while at rest, by the Service after receiving them.
If the API Print Service prints directly to printers on its network, standard LPR or RAW printing may be used, which will not encrypt print files between the Service and printer.
For unsecured or public networks between the Service and your printers, we recommend leveraging Off-Network Print to route documents from your system through a Vasion-hosted gateway in the cloud. The Internal Routing Service, hosted on a Service Client, opens a communication line to receive and download files to the printer. All print traffic is encrypted during this process.
Vasion Output is supported in both the Vasion Print and Virtual Appliance platforms. Vasion Print offers the most flexibility in terms of Vasion’s available configuration options.
For print jobs from Epic or our API Service, the Batch Printing functionality lets you collect batches of documents and print them in a specific order every time, ensuring complex processes remain standardized and efficient.