Skip to main content

Enum Reference

Common enumerated values used across the SureStage API.

User Status​

ValueDescription
activeUser has full access
invitedInvitation sent, pending acceptance
suspendedAccess temporarily revoked
deactivatedAccount disabled

Instance Status​

ValueDescription
runningInstance is active and accepting requests
stoppedInstance is configured but not serving
draftInstance is being configured
errorInstance encountered a startup error

HTTP Methods​

ValueDescription
GETRetrieve a resource
POSTCreate a resource
PUTReplace a resource
PATCHPartially update a resource
DELETERemove a resource
HEADRetrieve headers only
OPTIONSRetrieve allowed methods

Proxy Modes​

ValueDescription
proxyForward all requests to target
recordForward and record request/response pairs
replayReturn recorded responses
hybridReplay when available, proxy otherwise

Company Status​

ValueDescription
activeOrganization is operational
trialOrganization is in trial period
suspendedOrganization access is suspended
cancelledSubscription cancelled

Role Types​

ValueDescription
adminFull organizational control
editorCreate and modify resources
viewerRead-only access