# State Backed API ## Description This is version `1.0.0` of this API documentation. Last update on Oct 25, 2023. The official State Backed API for running XState backends as a service. State Backed turns any XState state machine into a stateful backend. Spawn instances of your machines, authorize requests, send events, and read your instances' state without any servers or datastores to manage. View the full State Backed documentation at https://docs.statebacked.dev. Download the `smply` CLI at https://npmjs.com/package/smply or at https://github.com/state-backed/smply/releases. ## Servers - Production server: https://api.statebacked.dev (Production server) ## Topics - [Authentication](https://api-docs.statebacked.dev/authentication.md) ## Endpoints and operations ### [Machines](https://api-docs.statebacked.dev/group/endpoint-machines.md) - [List your machines](https://api-docs.statebacked.dev/operation/operation-get-machines.md) - [Create a new machine definition.](https://api-docs.statebacked.dev/operation/operation-post-machines.md) - [Get a machine definition.](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter.md) - [Delete a machine and any versions and migrations associated with it.](https://api-docs.statebacked.dev/operation/operation-delete-machines-parameter.md) ### [Machine versions](https://api-docs.statebacked.dev/group/endpoint-machine-versions.md) - [List the machine versions for this machine](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter-v.md) - [Provisionally create a new machine definition version.](https://api-docs.statebacked.dev/operation/operation-post-machines-parameter-v.md) - [Finalize creation of a machine definition version.](https://api-docs.statebacked.dev/operation/operation-put-machines-parameter-v-parameter.md) ### [Machine version migrations](https://api-docs.statebacked.dev/group/endpoint-machine-version-migrations.md) - [Provisionally create a new machine version migration.](https://api-docs.statebacked.dev/operation/operation-post-machines-parameter-migrations.md) - [Finalize creation of a machine version migration.](https://api-docs.statebacked.dev/operation/operation-put-machines-parameter-migrations-parameter.md) ### [Machine instances](https://api-docs.statebacked.dev/group/endpoint-machine-instances.md) - [Create a new machine instance.](https://api-docs.statebacked.dev/operation/operation-post-machines-parameter.md) - [List the instances of this machine](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter-i.md) - [Get the current state of a machine instance.](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter-i-parameter.md) - [Delete a machine instance and any transitions, state, or pending upgrades associated with it.](https://api-docs.statebacked.dev/operation/operation-delete-machines-parameter-i-parameter.md) - [Query for machine instances using the indicated index.](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter-indexes-parameter-query.md) - [Get the administrative state of an instance](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter-i-parameter-admin.md) - [List the transitions for this machine instance](https://api-docs.statebacked.dev/operation/operation-get-machines-parameter-i-parameter-events.md) - [Send an event to a machine instance.](https://api-docs.statebacked.dev/operation/operation-post-machines-parameter-i-parameter-events.md) - [Update the desired machine version for an existing instance.](https://api-docs.statebacked.dev/operation/operation-put-machines-parameter-i-parameter-v.md) - [Update the status of a machine instance](https://api-docs.statebacked.dev/operation/operation-put-machines-parameter-i-parameter-status.md) ### [Logs](https://api-docs.statebacked.dev/group/endpoint-logs.md) - [Retrieve logs for a time range.](https://api-docs.statebacked.dev/operation/operation-get-logs.md) ### [Realtime](https://api-docs.statebacked.dev/group/endpoint-realtime.md) - [Subscribe to real-time updates of machine instances.](https://api-docs.statebacked.dev/operation/operation-get-rt.md) ### [Tokens](https://api-docs.statebacked.dev/group/endpoint-tokens.md) - [List the identity providers configured for your org](https://api-docs.statebacked.dev/operation/operation-get-idps.md) - [Upsert an identity provider](https://api-docs.statebacked.dev/operation/operation-post-idps.md) - [Delete an identity provider](https://api-docs.statebacked.dev/operation/operation-delete-idps.md) - [List the token providers configured for your org](https://api-docs.statebacked.dev/operation/operation-get-token-providers.md) - [Upsert a token provider](https://api-docs.statebacked.dev/operation/operation-post-token-providers.md) - [Delete a token provider](https://api-docs.statebacked.dev/operation/operation-delete-token-providers-parameter.md) - [Exchange an identity provider-signed token for a State Backed token](https://api-docs.statebacked.dev/operation/operation-post-tokens.md) ### [Orgs](https://api-docs.statebacked.dev/group/endpoint-orgs.md) - [List your organizations](https://api-docs.statebacked.dev/operation/operation-get-orgs.md) - [Create an org](https://api-docs.statebacked.dev/operation/operation-post-orgs.md) ### [Billing](https://api-docs.statebacked.dev/group/endpoint-billing.md) - [Retrieve the link to your organization's billing portal](https://api-docs.statebacked.dev/operation/operation-get-billing.md) ### [Keys](https://api-docs.statebacked.dev/group/endpoint-keys.md) - [List your keys](https://api-docs.statebacked.dev/operation/operation-get-keys.md) - [Create a key](https://api-docs.statebacked.dev/operation/operation-post-keys.md) - [Delete a key](https://api-docs.statebacked.dev/operation/operation-delete-keys-parameter.md) [Powered by Bump.sh](https://bump.sh)