List sign-off requests
The sign-off requests this credential made, newest first. A change an agent asks for that loosens a guardrail (raising a limit, removing a budget, adding an action, a looser approval policy) is not applied: it waits here until a workspace admin approves or rejects it in the console or from the link emailed to them. A console session lists the workspace’s requests. Nothing on this route decides a request.
/api/v2/sign-offsAuthorizationBearer token (Anlyon API key) · headerrequiredWorkspace API key sent as Authorization: Bearer <key>.
better-auth.session_tokenAPI key · cookierequiredBrowser session used by dashboard-only operations.
statusstringpendingappliedrejectedexpiredcancelledfailedlimitintegerX-Request-IdstringOptional caller correlation ID. Unsafe or oversized values are replaced.
Sign-off requests returned.
successbooleanrequiredtruedataSignOffRequest[]requiredShow propertiesHide properties
SignOffRequestobjectstringrequiredsign_off_requestidstringrequiredstatusstringrequiredpending until a workspace admin decides. applied: approved and in effect. rejected, expired (after 24 hours), cancelled (withdrawn by the credential) and failed (approved but could not be applied, see error): nothing changed.
pendingappliedrejectedexpiredcancelledfailedoperationstringrequiredpolicy.createpolicy.updatepolicy.deletepolicy_file.applyimpact_limit.updateimpact_limit.archivebudget.putbudget.deleteenvironment.resumeaction.createaction.updateaction.importsecret.putsecret_store.createsecret_store.updatesecret_store_settings.updateoauth_app.putenvironmentIdstring<uuid>requiredresourceobject | nullrequiredShow propertiesHide properties
typestringrequiredidstringrequirednamestringsummarystringrequiredchangesSignOffChange[]requiredShow propertiesHide properties
SignOffChangefieldstringrequiredfromany | nullrequiredThe value before. Never a secret value.
toany | nullrequiredThe value after. Never a secret value.
directionstringrequiredtighteninglooseningneutralreasonstringrequireddiffstringrequiredThe changes as plain text
signOffUrlstring<uri>requiredThe console page where a workspace admin approves or rejects it. Give this to a person.
pollUrlstringrequiredpollAfterSecondsintegerrequiredrequestedByobjectrequiredShow propertiesHide properties
typestringrequiredapi_keyoauth_clientsystemidstring | nullrequiredonBehalfOfstring | nullFor a CLI login or an MCP session
createdAtstring<date-time>requiredexpiresAtstring<date-time>requireddecidedAtstring<date-time> | nullrequireddecidedByobject | nullrequiredShow propertiesHide properties
typestringrequireduseridstringrequiredviastringrequiredconsoleemail_linkdecisionNotestring | nullrequiredresultany | nullrequiredWhen applied, what the original request would have returned: the limit, budget, policy or action as it now is.
errorobject | nullrequiredShow propertiesHide properties
codestringrequiredmessagestringrequiredBad Request - Invalid input data
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobjectfixErrorFixHow to get past this error, for a person or an agent. Present on refusals with a known next step, such as a missing scope or role, a plan or billing limit, a halted environment, or a missing secret, connected account, OAuth app or end-user header. Absent when there is no fix to give. Kept in production responses, unlike details.
Show propertiesHide properties
summarystringrequiredOne sentence that says what to do.
commandstringAn exact anlyon CLI command that fixes it. Absent when no command does.
urlstring<uri>An absolute console link where a person fixes it.
docsstring<uri>A docs page that explains it.
Unauthorized - Invalid or missing API key
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobjectfixErrorFixHow to get past this error, for a person or an agent. Present on refusals with a known next step, such as a missing scope or role, a plan or billing limit, a halted environment, or a missing secret, connected account, OAuth app or end-user header. Absent when there is no fix to give. Kept in production responses, unlike details.
Show propertiesHide properties
summarystringrequiredOne sentence that says what to do.
commandstringAn exact anlyon CLI command that fixes it. Absent when no command does.
urlstring<uri>An absolute console link where a person fixes it.
docsstring<uri>A docs page that explains it.
Too Many Requests - Rate limit exceeded. A workspace's API requests are limited per minute and per UTC clock hour by plan; Retry-After says when to try again, and an hourly refusal names the limit and when the count resets. Successful responses carry the same limits in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (the minute) and X-RateLimit-Limit-Hour, X-RateLimit-Remaining-Hour, X-RateLimit-Reset-Hour (the hour).
successbooleanrequiredrequestIdstringrequiredCorrelation ID matching the X-Request-Id response header.
errorobjectrequiredShow propertiesHide properties
codestringmessagestringdetailsobjectfixErrorFixHow to get past this error, for a person or an agent. Present on refusals with a known next step, such as a missing scope or role, a plan or billing limit, a halted environment, or a missing secret, connected account, OAuth app or end-user header. Absent when there is no fix to give. Kept in production responses, unlike details.
Show propertiesHide properties
summarystringrequiredOne sentence that says what to do.
commandstringAn exact anlyon CLI command that fixes it. Absent when no command does.
urlstring<uri>An absolute console link where a person fixes it.
docsstring<uri>A docs page that explains it.

