Skip to content
MyStocks Developers
API v1

API v1

Current stable contract

Versioning policyRelease changelog
Sandbox console
On-prem deployment

OnPrem partner and admin workflow

Follow access approval, credentials, DNS verification, installation, activation and renewal together.

Can we explore before DNS verification?

Yes. Eligible customers can request a restricted evaluation at OnPrem Access. It permits Sandbox exploration before domain ownership proof. It does not grant Live API access or skip identity, licensing and registry checks. Evaluation and activation rules describe current eligibility and limits.

What happens after submission?

The partner chooses the deployment target and hostname. /admin/partners?tab=onprem shows the request, organization association, approval scope, license expiry, domain state, installation release and next action. Admin confirms the authorized decision; shared state and notification records must reflect it. Retrieve the actual installation secret through the secure setup flow, not a public documentation page.

Which credentials do we use?

CredentialPurpose
Sandbox API keyVirtual hosted API requests.
Production API keySeparately approved Live API requests.
Installation licenseDomain and installation policy, activation and expiry wall.
Registry identityAuthorized download of the approved image.

None is interchangeable. Do not send passwords, private keys or licenses in onboarding free-text fields.

How do we install?

Follow the versioned installation guide for exact flags, checksum, DNS, TLS, ports, proxy modes, health checks, upgrade and rollback. Supported VM targets use one standard digest-pinned image, selected for the required architecture. Kubernetes and private-edge targets require a separately reviewed runbook. The installer uses explicit flags and secure key input; it does not provision an entire cloud network automatically.

How do verification and renewal work?

Publish the selected TXT or CNAME record in the partner's DNS zone. Verification can be pending, verified or failed and must be checked separately from request approval. Before Live activation, complete applicable domain and identity checks. Temporary licenses expire at the approved time; permanent licenses remain revocable. The expiry wall requires a new approved activation or renewal. Registry download access is a separate state and scheduled revocation can lag until cleanup succeeds.

Follow the OnPrem recipe, administration, API connectivity and troubleshooting. Successful email dispatch alone does not prove delivery, installation or API connectivity.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

On this page