Sign a gate policy

approval_policy.sign

Makes the pending version of a core.gate.<gate> policy current. The signer holds desk.settings.manage in the company now and did not write the version; the submitter signing their own refuses with approval_decider_refused. revisionHash binds the rows the signer read: a version replaced since refuses with approval_stale, and one past its 24 hours with approval_ended. Every role the rows name is checked again, so a role no member holds any more refuses with approval_policy_invalid. From your CLI login it takes your password and runs in the sandbox only; a live policy is signed in the browser. Callers: the account owner's own CLI login (`hyperscale auth login`). An agent token is refused.

POST /v1/approval-policies/{key}/sign

Principal user_session. Idempotency required. Environment either.

Input

Field	In	Type	Description
`key` required	path	`string`	The key a program names, such as funding.release
`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
`revisionHash` required	body	`string`	The pending version's revision, from approval_policy.list
`password`	body	`string`	Your password; required when you sign from your CLI login

Output

Field	Type	Description
`tenantId` required	`string`	Organization tenant ID
`key` required	`string`	The key a program names, such as funding.release
`status` required	`"current"`
`version` required	`integer`
`digest` required	`string`
`approvalId` required	`string`

Request sample

Only a signed-in person may call this: the founder's own CLI after hyperscale auth login. 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/approval-policies/core.gate.go_live/sign' \
  --header "Authorization: Bearer $HYPERSCALE_TOKEN" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header "Idempotency-Key: $(uuidgen)" \
  --header 'Content-Type: application/json' \
  --data-raw '{"tenantId":"ten_sandbox_riyadhresale01","revisionHash":"0000000000000000000000000000000000000000000000000000000000000000"}'

CLI

hyperscale api call approval_policy.sign \
  --input '{"key":"core.gate.go_live","tenantId":"ten_sandbox_riyadhresale01","revisionHash":"0000000000000000000000000000000000000000000000000000000000000000"}'

Errors

Code	HTTP	Cause
`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.
`product_access_suspended`	403	The Product is disabled or closed, so its credentials are suspended in every environment.
`product_activation_required`	403	The live Product or required live capability is not active yet.
`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.
`approval_decider_refused`	403	The decider made the call, already decided this approval from some session, or holds no authority for the step it waits on. Nothing changed.
`approval_ended`	409	The approval is no longer pending: it was approved and ran, or was rejected, returned or expired. Nothing changed.
`approval_policy_invalid`	422	Two rows cover one amount, a row with no band sits beside others, or a row names a staff role no member of the company holds. No version was written.
`approval_stale`	409	The decision named another revision than the one the approval binds. Nothing changed.
`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.
`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.
`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.

All operations