StudioHomepage
ServicesApplicationsHTTP APIInstallations

Request an installation

POST
/api/apps/installations

Request that an Application be installed in your Organization, or request more scopes or Projects for an existing installation. Any member of the Organization can send a request. The scopes must be registered on the Application. Until an owner approves the request, the installation keeps its earlier approval.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Request Body

application/json
  1. body
applicationId*string
projects*

Every Project in the Organization, including Projects created later, when all is true. Otherwise, only the listed Projects.

scopes*array<string>

Response Body

Success

application/json
  1. response

An Application installed in one Organization, where it acts as its own identity. requested is the latest request. approved is what an Organization owner approved, and it is the only grant that Spiral enforces. A request for more access takes effect only when an owner approves it.

applicationId*string
approved?|null
id*string
organizationId*string
requested*
status*apps.InstallationStatus
Value in"requested""active""suspended"
curl -X POST 'https://api.spiraldb.dev/api/apps/installations' \  -H 'Content-Type: application/json' \  -d '{  "applicationId": "string",  "projects": {    "all": true,    "projectIds": [      "string"    ]  },  "scopes": [    "string"  ]}'
{  "applicationId": "string",  "approved": {    "projects": {      "all": true,      "projectIds": [        "string"      ]    },    "scopes": [      "string"    ]  },  "id": "string",  "organizationId": "string",  "requested": {    "projects": {      "all": true,      "projectIds": [        "string"      ]    },    "scopes": [      "string"    ]  },  "status": "requested"}