Skip to content
MyStocks Developers
API v1

API v1

Current stable contract

Versioning policyRelease changelog
Sandbox console
← All recipes

Install and Renew OnPrem Access

Depends on access, DNS, identity and infrastructure readiness

Use the same standard image across supported Linux hosts. Hosted API credentials, installation licenses and registry access remain separate. Evaluation approval allows restricted Sandbox use before DNS proof; Live activation remains an independent authorized decision.

The flow

StepEndpoint / EventWhat it does
1OnPrem Access requestChoose target, domain and evaluation or enterprise access. Do not submit passwords or private keys.
2Admin requests and activationsConfirm the organization, approval scope, compatible release, expiry and next required action. Retrieve secrets through the secure installation-key flow.
3Domain verificationPublish the selected TXT or CNAME ownership record on the partner domain; review pending, verified or failed state. DNS ownership does not create an installation.
4Install an approved digestPrepare Docker, DNS, TLS, registry authentication and authoritative identity domains. Run the reviewed versioned installer.
5GET /installationsAuthorized Live organization members can inspect their installation state; use the portal for evaluation setup and secret retrieval.
6Renew or revokeAdmin-controlled expiry and revocation enforce the wall. An evaluation license cannot authenticate Live API requests.

Common mistakes

  • —Do not use a Sandbox API key as an installation license or registry password.
  • —Do not bypass the installer checksum or use a mutable image tag instead of the approved digest.
  • —Do not claim Kubernetes or private-edge provisioning is automatic; those targets require a reviewed architecture runbook.

Prove it in sandbox first

  • 1.Evaluation supports restricted Sandbox exploration before DNS ownership proof; permanent access remains revocable and Live activation has separate requirements.
  • 2.Verify health, authentication, API proxy routing and the expiry wall. Approval-email dispatch is not proof of email delivery, DNS ownership or successful installation.