Submit a Core digest to one gate
product.gate.submit
Opens the approval that signs one gate on one Core digest, under the tenant's policy `core.gate.<gate>`. The call answers 202 approval_required with the approvalId and revisionHash, which binds the gate, the digest and the policy digest; the people the policy names decide it with approval.decide, and the maker never does. When the last step approves, the call runs once as the maker and answers with the signed gate and every decision. It refuses with core_digest_unknown when coreDigest is neither the Product's sandbox Core nor its live Core, gate_not_required when the tenant has no policy for the gate, gate_already_open or gate_already_signed when an approval on the same digest waits or signed, and, for SIT and UAT, gate_checks_failing while the stored check outcome for the digest has a failing check. A new digest has no approvals, so every gate opens again. Callers: the account owner's CLI login, or an agent token with products:write, or a personal access token with products:write.
POST /v1/products/{productId}/gates/{gate}
Principal user_session. Idempotency required. Environment sandbox.
Input
| Field | In | Type | Description |
|---|---|---|---|
productId required | path | string | Hyperscale product ID |
gate required | path | design_review | infosec | sit | uat | go_live | |
X-Hyperscale-Environment | header | sandbox | live | |
Idempotency-Key required | header | string | |
X-Hyperscale-Rehearsal | header | "true" | `true` runs the request through admission and execution, keeps nothing, and answers OperationRehearsal with 200 in place of the operation's own output. Needs a signed-in caller. Identity operations, such as sign-in, sessions, team members and agent grants, refuse it with invalid_request. |
tenantId required | body | string | Organization tenant ID |
coreDigest required | body | string | The Core the gate signs: the Product's sandbox or live Core |
Output
| Field | Type | Description |
|---|---|---|
tenantId required | string | Organization tenant ID |
productId required | string | Hyperscale product ID |
gate required | design_review | infosec | sit | uat | go_live | |
coreDigest required | string | SHA-256 digest of the resolved Core closure |
state required | "signed" | |
approval required | object | The approval that signed the gate: its policy version and every decision |
Request sample
Only a signed-in person may call this: the CLI after hyperscale auth login, or curl with a personal access token (hyperscale_pat_...) with products:write or an agent token with products:write. The agent's grant must span every Product the call reads. A Product key cannot, so the SDK, which signs in with a Product key or a customer session, has no sample for it.
curl
curl --request POST 'https://hyperscale0.ai/v1/products/prd_sandbox_00000000000000000001/gates/sit' \
--header "Authorization: Bearer $HYPERSCALE_TOKEN" \
--header 'X-Hyperscale-Environment: sandbox' \
--header "Idempotency-Key: $(uuidgen)" \
--header 'Content-Type: application/json' \
--data-raw '{"tenantId":"ten_sandbox_00000000000000000001","coreDigest":"3f2a9c41d7e8b65a0c1f4e2d9b8a7c6e5f4d3c2b1a09f8e7d6c5b4a39281706f"}'CLI
hyperscale api call product.gate.submit \
--input '{"gate":"sit","tenantId":"ten_sandbox_00000000000000000001","coreDigest":"3f2a9c41d7e8b65a0c1f4e2d9b8a7c6e5f4d3c2b1a09f8e7d6c5b4a39281706f"}'Errors
| Code | HTTP | Cause |
|---|---|---|
agent_reason_required | 400 | An agent sent a change without saying why, or the reason is shorter than 8 or longer than 280 characters. |
agent_result_already_delivered | 409 | A caller already claimed this approval's one-time result. |
approval_rejected | 403 | A person rejected the call or returned it to the maker, so it never runs. |
approval_required | 202 | The call waits for decisions: an agent's call over its grant waits on its delegator, and a program action under `requires approval` waits on distinct people other than the maker. |
csrf_token_invalid | 403 | A browser session mutation did not carry a current Hyperscale CSRF token. |
environment_mismatch | 403 | The session was issued for sandbox or live and the request targets the other environment. |
idempotency_conflict | 409 | The request reused an Idempotency-Key for a different logical mutation. |
idempotency_required | 400 | The operation is a mutation and Hyperscale requires a replay key before executing it. |
internal_error | 500 | Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience. |
invalid_request | 400 | The request does not match the API reference. |
method_not_allowed | 405 | The route exists, but not for the request's HTTP method. |
missing_required_permission | 403 | The signed-in member's current role does not grant the permission required for this operation. |
missing_required_scope | 403 | The credential is valid but does not grant one or more operation scopes. |
not_found | 404 | No Hyperscale route matched the requested path and method. |
oauth_client_not_admitted | 403 | The bearer is an OAuth client token, and this operation does not admit the oauth2_client principal. |
rate_limited | 429 | The credential sent more than its limit in the current 60-second window: 600 requests per API key or session, 1,200 per IP address. Every response carries `x-ratelimit-limit`, `x-ratelimit-remaining` and `x-ratelimit-reset` (Unix seconds). |
request_body_too_large | 413 | The JSON request body exceeded Hyperscale's accepted payload size. |
resource_not_found | 404 | The requested resource does not exist in the credential's visible scope. |
state_conflict | 409 | The operation conflicts with the current durable state of the resource. |
state_constraint_failed | 422 | The request is syntactically valid but violates a business-state constraint. |
tenant_mismatch | 403 | The request mixed tenant-owned identifiers across tenant boundaries. |
tenant_not_found | 404 | The credential resolved to a tenant Hyperscale cannot find. |
unauthorized | 403 | The request did not include a valid Hyperscale bearer credential for this environment. |
agent_token_expired | 401 | The agent token is real, but its grant ended. A grant lasts 30 days, or 7 days unused. `details.expiresAt` holds the date in ISO 8601 and `details.agentName` names the agent. |
agent_token_replaced | 401 | The account owner ran `hyperscale agent setup` again for this agent, which replaced this token with a newer one. `details.agentName` names the agent and `details.replacedAt` holds the date. |
core_digest_unknown | 404 | A gate signs one Core of the Product: its current sandbox Core or its live Core. coreDigest names neither. details.sandboxCoreDigest and details.liveCoreDigest name the two it accepts. |
device_login_expired | 401 | The bearer is the account owner's own device login from `hyperscale auth login`, not an agent token. Its access token lasts an hour and the CLI refreshes it; the login itself ends after 30 days, or 7 days unused. `details.expiresAt` holds when it ended in ISO 8601. |
gate_already_open | 409 | An approval for this gate on this Core digest is pending. details.approvalId names it. |
gate_already_signed | 409 | Every step of an approval for this gate on this Core digest approved. details.approvalId names it. |
gate_checks_failing | 409 | SIT and UAT sign the Core's stored check outcome, and at least one check on this digest failed. details.failures names each one. |
gate_not_required | 409 | The company has written no approval policy under details.key in this environment, so the gate is not required and nobody would sign it. |
instrument_instance_not_found | 404 | No record of this instrument matches the `instanceId` in this Product, company and environment. `details.instrumentId` and `details.instrumentInstanceId` name what was looked up. |
invalid_credentials | 401 | Hyperscale could not accept the account or credential request. Signup, login, and bearer authentication use one 401 for every case they reject, so the response exposes no credential-specific reason or registered-email verdict. The single exception is a key that is real but homed in the other environment: because the presented secret already matched a stored key, the message names the mismatch instead of leaving a working credential looking unknown. A bearer that matched nothing gets text that fits its prefix (an agent token, a refresh token, a personal access token, a session or no Hyperscale token at all), which says only what the caller sent, never whether a credential like it exists. |
operation_not_finalized | 409 | The operation in `details.operationId` has started but has no final receipt. It is still running, or its outcome is unknown after a failure past the point where it may have committed. `details.error` carries the underlying failure when there is one. |
product_not_found | 404 | No Product matches the `productId` in this tenant and environment, or a resource the request names belongs to a different Product than the API key's. A missing, foreign or ambiguous resource binding also reports this code. |
session_expired | 401 | The session behind this request has ended. A console session ends 30 days after sign-in, or after 12 hours with no request. An admin or customer session ends 24 hours after sign-in, or after 15 minutes with no request. A personal access token ends at the `expiresAt` set when it was created. |
session_required | 401 | This operation needs a person signed in through the browser or the `hyperscale` CLI. A Product API key cannot call it. The request carried no session, or its token matched no live session. |
session_revoked | 401 | The session or personal access token behind this request was ended before its expiry. Sign-out, `user.session.revoke`, a password reset, a role change, removal from the team, user suspension and `personal_access_token.revoke` all end sessions. |
tenant_status_forbidden | 409 | The company is suspended or closed, so every credential bound to it is refused, reads included. `details.tenantId` names the company. |