Skip to content

Knowledgebase

Download a published connector using a one-time artifact grant

domain-nexus, development

A reseller downloads an eligible published connector through a short-lived, one-time artifact grant. Keep the package version and digest with your deployment record. A download URL is not a permanent public distribution link and should not be shared with unrelated accounts.

Method Resource Scope Idempotency-Key
GET /v2/connectors connectors:read Not required by this route
POST /v2/connectors/artifacts/{artifactId}/download-token connectors:download Required
GET /v2/connectors/artifacts/{artifactId}/download connectors:download Not required by this route

01 Download a verified publication

  1. Read /v2/connectors and filter by the required supported platform. Follow the returned pagination and inspect the publication's name, version, documentation and artifact.
  2. Select the artifact ID from that eligible publication. Check that it matches the billing platform you intend to install.
  3. Request download-token with an idempotency key. Save the returned token, artifact digest and expires_at.
  4. Immediately request the artifact's download endpoint with the token. You can use X-Download-Token to avoid placing the token in the query string.
  5. Save the binary ZIP response. Do not pass successful ZIP bytes through your normal JSON-envelope parser.
  6. Verify the package digest and inspect the supplied installation instructions before uploading files to the billing platform.

02 Recover a failed download

The current grant lifetime is 120 seconds, but always follow the returned expiry. If a grant has expired or been consumed, obtain a fresh grant. Repeating the old grant request with its original idempotency key may replay the original response rather than produce a new usable token.

If the connection ended after consuming the grant, first check whether the saved ZIP is complete and matches the expected digest. A new download attempt needs its own valid grant. Publication withdrawal or changed account eligibility can prevent a replacement download.

Common questions

Why is the connector catalogue empty?

There may be no published release available to your account, group or platform. Ask the publisher to check audience and release state. An empty catalogue is not evidence of a browser download problem.

Can I call the old build route to create my own package?

Ordinary resellers use published downloads. The older build and publish endpoints require publisher access and return PUBLISHER_WORKFLOW_REQUIRED; current publishing uses Connector Studio or the master catalogue workflow.

Does the ZIP contain my API secret?

Configure credentials through the connector's supported setup after installation. Keep generated package identity and account authentication separate, and never place a live secret in a publicly shared archive.

Was this answer helpful?

Need a little more help?

Our support team can help you find the next step.

Contact support

Powered by WHMCompleteSolution