Configure API Cloud Link

Last Updated: April 28, 2026

Here are the steps to configure API Cloud Link in your environment.

Key Points

  • Review the Requirements before configuring this feature.
  • API Cloud Link supports RESTful API requests and IPP printing requests.
  • API Tokens support both request types.

API Requests

The endpoint structure used for API requests depends on whether you are using a RESTful API or IPP printing. Use the appropriate endpoint below when configuring this service.

RESTful API Requests

 

Copy Code

Endpoint

https://external-api.app.printercloud-fed.us/v1/print

RESTful API requests support API Tokens to authenticate requests from external applications or tools. Use the appropriate steps in the 2. Configure Authentication section when setting up your authentication method. RESTful API requests require the following HTTP headers.

Copy Code
Example
Authorization: "<API or JWT token>"
X-Site-ID: "<Your_Instance_Subdomain>"

IPP Printing Requests

 

Copy Code

Endpoint

https://external-api.app.printercloud-fed.us/v1/ipp/print/<Printer Name>

IPP Printing requests require an API Token to authenticate requests from external applications or tools. Use the API Token steps in the 2. Configure Authentication section when setting up your authentication method. API requests require the following HTTP header.

Copy Code
Example
Authorization: "<API token>"
  1. In the Admin Console, go to the API Cloud Printing section on Tools then Settings then Output.
  2. Select API Cloud Link Enabled.
  3. Select Save in the upper-right corner.

API Cloud Printing setting as seen in the Admin Console.

2. Configure Authentication

Follow the steps in the section below when setting up your authentication method.

API Tokens

  1. Go to Tools then Tokens then API Keys.

  2. Select the Generate button in the upper-left.

    Newly generated API Keys appear at the bottom of the Active API Keys list.

  3. Select the View Keys button in the Active API Keys section.
  4. Copy the token for the newly created API Key.

Add the API key into the request HTTP header to authenticate requests from external applications and tools. For more details refer to API Cloud Link Schemas.

Next Steps

Troubleshooting Help