Get a sign-off request

Poll a request the credential made until its status is no longer pending, waiting pollAfterSeconds between reads. applied means a workspace admin approved it and the change took effect, with the result in result. rejected, expired, cancelled and failed mean nothing changed. A request expires 24 hours after it was made.

GET/api/v2/sign-offs/{signOffId}

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Path parameters

signOffIdstringrequired

Sign-off request id (sor_...).

matches ^sor_[A-Za-z0-9_-]{1,64}$

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Sign-off request returned.

successbooleanrequired

Allowed:true

dataSignOffRequestrequired

A governance change that loosens a guardrail, asked for by an API key, a CLI login or an MCP session, waiting for a workspace admin. Give signOffUrl to a person; poll pollUrl.

Show properties

objectstringrequired

Allowed:sign_off_request

idstringrequired

statusstringrequired

pending 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.

Allowed:pendingappliedrejectedexpiredcancelledfailed

operationstringrequired

Allowed:policy.createpolicy.updatepolicy.deletepolicy_file.applyimpact_limit.updateimpact_limit.archivebudget.putbudget.deleteenvironment.resumeaction.createaction.updateaction.importsecret.putsecret_store.createsecret_store.updatesecret_store_settings.updateoauth_app.put

environmentIdstring<uuid>required

resourceobject | nullrequired

Show properties

typestringrequired

idstringrequired

namestring

summarystringrequired

changesSignOffChange[]required

Show properties

Array of SignOffChange

fieldstringrequired

fromany | nullrequired

The value before. Never a secret value.

toany | nullrequired

The value after. Never a secret value.

directionstringrequired

Allowed:tighteninglooseningneutral

reasonstringrequired

diffstringrequired

The changes as plain text

signOffUrlstring<uri>required

The console page where a workspace admin approves or rejects it. Give this to a person.

pollUrlstringrequired

pollAfterSecondsintegerrequired

requestedByobjectrequired

Show properties

typestringrequired

Allowed:api_keyoauth_clientsystem

idstring | nullrequired

onBehalfOfstring | null

For a CLI login or an MCP session

createdAtstring<date-time>required

expiresAtstring<date-time>required

decidedAtstring<date-time> | nullrequired

decidedByobject | nullrequired

Show properties

typestringrequired

Allowed:user

idstringrequired

viastringrequired

Allowed:consoleemail_link

decisionNotestring | nullrequired

resultany | nullrequired

When applied, what the original request would have returned: the limit, budget, policy or action as it now is.

errorobject | nullrequired

Show properties

codestringrequired

messagestringrequired

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

How 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 properties

summarystringrequired

One sentence that says what to do.

commandstring

An 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.

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An 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.

404

Not Found - Resource does not exist

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An 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.

429

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).

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An 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.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.signOffIdpath*Sign-off request id (sor_...).

Request

curl -X GET 'https://api.anlyon.com/api/v2/sign-offs/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/sign-offs/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/sign-offs/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "object": "sign_off_request",
    "id": "sor_V1StGXR8Z5jdHi6BmyT9q",
    "status": "pending",
    "operation": "impact_limit.update",
    "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
    "resource": {
      "type": "impact_limit",
      "id": "lim_01JABCDEF",
      "name": "Daily refunds"
    },
    "summary": "Raise impact limit \"Daily refunds\" from 500 to 5000 usd",
    "changes": [
      {
        "field": "amount",
        "from": 500,
        "to": 5000,
        "direction": "loosening",
        "reason": "Raises the limit."
      }
    ],
    "diff": "amount (loosens): Raises the limit.\n- 500\n+ 5000",
    "signOffUrl": "https://console.anlyon.com/sign-offs/sor_V1StGXR8Z5jdHi6BmyT9q",
    "pollUrl": "/api/v2/sign-offs/sor_V1StGXR8Z5jdHi6BmyT9q",
    "pollAfterSeconds": 5,
    "requestedBy": {
      "type": "api_key",
      "id": "string",
      "onBehalfOf": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "decidedAt": "2019-08-24T14:15:22Z",
    "decidedBy": {
      "type": "user",
      "id": "string",
      "via": "console"
    },
    "decisionNote": "string",
    "result": null,
    "error": {
      "code": "SIGN_OFF_STALE",
      "message": "string"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}