Submit an approval request
springroll.approval.submitSubmits an approval request of any supported type: UAT_PROMOTION, UAT_SIGN_OFF, PRODUCTION_PROMOTION, VISIBILITY_CHANGE, OWNERSHIP_TRANSFER, RETIREMENT, DOMAIN_CHANGE, or ROLLBACK. An agent may submit but never decide: SpringRoll requires a human approver, and an agent token cannot approve its own request.
Confirm with the user before calling this. It creates review work for named people.
Type-specific behaviour:
• PRODUCTION_PROMOTION: this does NOT deploy. It asks. releaseId defaults to the application's latest release. Once approved, call springroll.deploy.promote.
• ROLLBACK: justification is required, and targetEnvironmentType says which environment to roll back. Put the deployment to restore in payload.targetDeploymentId; it defaults to the last successful one.
• RETIREMENT: justification is required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| context | Yes | Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization." | |
| payload | No | Type-specific detail, e.g. { visibility: 'TENANT' }, { newOwnerMembershipId: '…' }, or { targetDeploymentId: '…' } for a rollback. | |
| releaseId | No | Release this concerns. For PRODUCTION_PROMOTION, defaults to the latest release. | |
| application | Yes | Application slug or id. | |
| requestType | Yes | ||
| justification | No | Why this should happen. Shown to reviewers. Required for ROLLBACK and RETIREMENT, and at least 10 characters when required. | |
| idempotencyKey | Yes | Required. A stable, caller-generated key. Retrying with the same key returns the original result instead of creating a duplicate. | |
| targetEnvironmentType | No | Canonical environment class. SpringRoll promotes development -> uat -> production. |