State Backed API documentation

Changelog

Last update:
Compare

API structure has changed

Modified 1 Breaking
GET /machines/{machineSlug}/indexes/{index}/query
  • Response
  • 200 response Modified
    • machineInstances attribute Removed
      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • instances attribute Added

API structure has changed

Modified 4
GET /keys
  • Response
  • 200 response Modified
    • keys attribute Modified
GET /machines/{machineSlug}
  • Response
  • 200 response Modified
    • machine attribute Modified
GET /machines/{machineSlug}/indexes/{index}/query
  • Response
  • 200 response Modified
    • machineInstances attribute Modified
      • Type went from array to array[object]

POST /machines
  • Body
  • content type Modified
    • indexes attribute Modified
      • Type went from array to array[string]

API structure has changed

Added 1
GET /machines/{machineSlug}/indexes/{index}/query

API structure has changed

Modified 3
GET /machines/{machineSlug}
  • Response
  • 200 response Modified
    • machine attribute Modified
POST /machines
  • Body
  • content type Modified
    • indexes attribute Added
PUT /machines/{machineSlug}/v/{signedMachineVersionId}
  • Body
  • content type Modified
    • indexSelectors attribute Added

API structure has changed

Modified 3
GET /machines/{machineSlug}/i/{instanceSlug}
  • Response
  • 200 response Modified
    • ts attribute Added
POST /machines/{machineSlug}
  • Response
  • 200 response Modified
    • ts attribute Added
POST /machines/{machineSlug}/i/{instanceSlug}/events
  • Response
  • 200 response Modified
    • ts attribute Added

API structure has changed

Modified 1
POST /orgs
  • Body
  • content type Modified
    • allowAnonymousAccess attribute Added

API structure has changed

Modified 1
GET /orgs
  • Response
  • 200 response Modified
    • orgs attribute Modified

API structure has changed

Modified 2 Breaking
GET /machines/{machineSlug}
  • Response
  • 200 response Modified
    • createdAt, currentVersion attributes Removed
    • machine attribute Added
GET /machines/{machineSlug}/i/{instanceSlug}/admin
  • Response
  • 200 response Modified
    • createdAt attribute Added

API structure has changed

Modified 1
POST /keys
  • Authentication
  • Bearer auth authentication method Added
Added 2
DELETE /keys/{keyId}
POST /orgs

API structure has changed

Added 1
POST /keys

API structure has changed

Added 2
GET /machines/{machineSlug}
GET /machines/{machineSlug}/i/{instanceSlug}/admin

API structure has changed

Modified 1
GET /idps
  • Response
  • 200 response Modified
    • idps attribute Modified

API structure has changed

Added 9
GET /billing
GET /idps
GET /keys
GET /machines
GET /machines/{machineSlug}/i
GET /machines/{machineSlug}/i/{instanceSlug}/events
GET /machines/{machineSlug}/v
GET /orgs
GET /token-providers

API structure has changed

Modified 3 Breaking
GET /machines/{machineSlug}/i/{instanceSlug}
  • Response
  • 200 response Modified
    • tags, done attributes Modified
POST /machines/{machineSlug}
  • Response
  • 200 response Modified
    • tags, done attributes Modified
POST /machines/{machineSlug}/i/{instanceSlug}/events
  • Response
  • 200 response Modified
    • tags, done attributes Modified

API structure has changed

Modified 3
GET /machines/{machineSlug}/i/{instanceSlug}
  • Response
  • 200 response Modified
    • tags, done attributes Added
POST /machines/{machineSlug}
  • Response
  • 200 response Modified
    • tags, done attributes Added
POST /machines/{machineSlug}/i/{instanceSlug}/events
  • Response
  • 200 response Modified
    • tags, done attributes Added

API structure has changed

Modified 3 Breaking
GET /machines/{machineSlug}/i/{instanceSlug}
  • Response
  • 200 response Modified
    • states attribute Removed
POST /machines/{machineSlug}
  • Response
  • 200 response Modified
    • states attribute Removed
POST /machines/{machineSlug}/i/{instanceSlug}/events
  • Response
  • 200 response Modified
    • states attribute Removed

API structure has changed

Added 1
POST /tokens

API structure has changed

Added 4
DELETE /idps
DELETE /token-providers/{service}
POST /idps
POST /token-providers

API structure has changed

Modified 3 Breaking
DELETE /machines/{machineSlug}
  • Response
  • 200 response Removed
  • 204 response Added
DELETE /machines/{machineSlug}/i/{instanceSlug}
  • Response
  • 200 response Removed
  • 204 response Added
PUT /machines/{machineSlug}/i/{instanceSlug}/status
  • Response
  • 201 response Removed
  • 204 response Added

API structure has changed

Modified 2 Breaking
DELETE /machines/{machineSlug}
  • Body
  • content type Modified
    • dangerDataWillBeDeletedForever, hmacSha256OfMachineNameWithMachineNameKey attributes Modified
DELETE /machines/{machineSlug}/i/{instanceSlug}
  • Body
  • content type Modified
    • dangerDataWillBeDeletedForever, hmacSha256OfMachineInstanceNameWithMachineNameKey attributes Modified