About the API

The Job Runner API is available on Squiz DXP for every customer who has Job Runner enabled.

Access the API docs from your instance

The Job Runner API uses a URL pattern of /__dxp/{region}/job-runner/{tenantId}/docs/ to serve the latest version of the API.

{region}: Either au, us, uk depending on the hosting region set up for your DXP organization.
{tenant}: Your DXP tenant ID. You can find this value when you sign into your organization through the https://dxp.squiz.cloud URL.

To view the hosted API docs:

Load https://dxp.squiz.cloud
Authenticate using SSO.
Take note of your DXP Tenant ID which is shown after /organization/ in the URL.
In the browser address bar, replace the /organization/{your-tenant-id} segment with /__dxp/{region}/job-runner/{tenantId}/docs/
Change these values in the URL:

{region}

Either au, us, uk depending on the hosting region set up for your DXP organization.

{tenant}

The DXP tenant ID you took note of earlier in this procedure.
Press Return in your browser address bar to load the API docs.
Optionally change the region and tenantId server variables to set the variables for the interactive Swagger UI mode (Authentication required).