Quome API Summary
To make requests to the Quome API, use https://demo.quome.cloud/api/v1 as the route prefix and attach the endpoint as seen in the table below. For example, to list all of your Organizations, make the request:
GET https://demo.quome.cloud/api/v1/orgs
All data is returned in JSON.
API Endpoints
Openapi docs page
There is also an openapi docs page provided with the Quome API which can be found at https://demo.quome.cloud/api/v1/spec/docs.html
Users and Organizations
| Description | Endpoint | HTTP Request Type | Input parameters | Error Codes |
|---|---|---|---|---|
| Returns the current user | /users | GET | ||
| Returns a user by their ID | /users/:id | GET | ||
| Returns all your Organizations | /orgs | GET | ||
| Returns a specific Organization | /orgs/:orgID | GET | ||
| Creates an Organization | /orgs | POST | ||
| Returns members of an Organization | /orgs/:orgID/members | GET | ||
| Adds a member to an Organization | /orgs/:orgID/members | POST | ||
| Returns all API keys in the Organization | /orgs/:orgID/apikeys | GET | ||
| Creates a new API key in the Organization | /orgs/:orgID/apikeys | POST | ||
| Deletes an API key from the Organization | /orgs/:orgID/apikeys/:id | DELETE |
Apps
| Description | Endpoint | HTTP Request Type | Input parameters | Error Codes |
|---|---|---|---|---|
| Returns all apps in the Organization | /orgs/:orgID/apps | GET | ||
| Creates an app | /orgs/:orgID/apps | POST | ||
| Returns a specific app | /orgs/:orgID/apps/:id | GET | ||
| Redeploys an app | /orgs/:orgID/apps/:id | PUT | ||
| Deletes an app | /orgs/:orgID/apps/:id | DELETE | ||
| Returns the logs for an app | /orgs/:orgID/apps/:id/logs | GET |
Databases
| Description | Endpoint | HTTP Request Type | Input parameters | Error Codes |
|---|---|---|---|---|
| Returns all databases in the Organization | /orgs/:orgID/dbaas | GET | ||
| Creates a database | /orgs/:orgID/dbaas | POST | ||
| Returns a specific database | /orgs/:orgID/dbaas/:id | GET | ||
| Updates a database | /orgs/:orgID/dbaas/:id | PUT | ||
| Deletes a database | /orgs/:orgID/dbaas/:id | DELETE |
Secrets
| Description | Endpoint | HTTP Request Type | Input parameters | Error Codes |
|---|---|---|---|---|
| Returns all Secrets in the Organization | /orgs/:orgID/secrets | GET | ||
| Creates a Secret | /orgs/:orgID/secrets | POST | ||
| Returns a specific Secret | /orgs/:orgID/secrets/:id | GET | ||
| Updates a Secret | /orgs/:orgID/secrets/:id | PUT | ||
| Deletes a Secret | /orgs/:orgID/secrets/:id | DELETE |
App Deployments
| Description | Endpoint | HTTP Request Type | Input parameters | Error Codes |
|---|---|---|---|---|
| Returns details for all deployments in the Organization, including their SBOM | /orgs/:orgID/apps/:id/deployments | GET | ||
| Returns a specific a deployment | /orgs/:orgID/apps/:id/deployments/:deployment_id | GET |
Events
| Description | Endpoint | HTTP Request Type | Input parameters | Error Codes |
|---|---|---|---|---|
| Returns all events in the Organization's audit log | /orgs/:orgID/events | GET |