Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
State Backed documentation
State Backed

Topics

  • Introduction
  • Authentication

Endpoints

  • Machines
    • List your machines GET
    • Create a new machine definition. POST
    • Get a machine definition. GET
    • Delete a machine and any versions and migrations associated with it. DELETE
  • Machine versions
    • List the machine versions for this machine GET
    • Provisionally create a new machine definition version. POST
    • Finalize creation of a machine definition version. PUT
  • Machine version migrations
    • Provisionally create a new machine version migration. POST
    • Finalize creation of a machine version migration. PUT
  • Machine instances
    • Create a new machine instance. POST
    • List the instances of this machine GET
    • Get the current state of a machine instance. GET
    • Delete a machine instance and any transitions, state, or pending upgrades associated with it. DELETE
    • Query for machine instances using the indicated index. GET
    • Get the administrative state of an instance GET
    • List the transitions for this machine instance GET
    • Send an event to a machine instance. POST
    • Update the desired machine version for an existing instance. PUT
    • Update the status of a machine instance PUT
  • Logs
    • Retrieve logs for a time range. GET
  • Realtime
    • Subscribe to real-time updates of machine instances. GET
  • Tokens
    • List the identity providers configured for your org GET
    • Upsert an identity provider POST
    • Delete an identity provider DELETE
    • List the token providers configured for your org GET
    • Upsert a token provider POST
    • Delete a token provider DELETE
    • Exchange an identity provider-signed token for a State Backed token POST
  • Orgs
    • List your organizations GET
    • Create an org POST
  • Billing
    • Retrieve the link to your organization's billing portal GET
  • Keys
    • List your keys GET
    • Create a key POST
    • Delete a key DELETE
  • Custom HTTP API
    • Invoke the custom HTTP API you defined within your machine definition. GET
    • Invoke the custom HTTP API you defined within your machine definition. PUT
    • Invoke the custom HTTP API you defined within your machine definition. POST
    • Invoke the custom HTTP API you defined within your machine definition. DELETE
    • Invoke the custom HTTP API you defined within your machine definition. OPTIONS
    • Invoke the custom HTTP API you defined within your machine definition. HEAD
    • Invoke the custom HTTP API you defined within your machine definition. PATCH
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
State Backed documentation
State Backed

Custom HTTP API

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown