FeatureBase Cloud allows you to launch FeatureBase clusters as a managed service in the cloud.

Customers can use REST APIs to perform CRUDL (Create/Read/Update/Delete/List) operations on their cloud resources. Every resource belongs to an organization. Each API resource type can be managed via a dedicated API endpoint. Resource types include:

• Databases
• Query
• Invites
• Users
• Orgs
• Shapes
• Roles

All API errors include a JSON body with a human-readable message and a machine-readable error code designed for programmatic parsing. For example:

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 469
{
  "code": "InvalidParameter",
  "message": "The value for 'count' has to be greater than 0."
}

The following table describes the most common error types and their usage:

HTTP Response Status Code	Example Message	Client Retry Behavior
400	Message includes the SQL3 error response.	No
401	Authorization failed	No
403	User does not have the access to perform this action.	No
404	Resource not found.	No
408	The client cancelled the request or failed to send a full request.	Yes
409	Requested resource already exists.	No
409	The referenced resource is not ready to process requests.	Retry with backoff
413	The size of the request payload exceeds the maximum size permitted.	No
422	Unprocessable entity	Retry with correct resource information
429	API rate limit exceeded.	Retry with backoff
500	Unexpected error	Retry with backoff
501	Did not implement this method	No
503	The service is unavailable at the moment.	Retry with backoff

JWT or ApiKeyAuth

HTTP: JWT

To authenticate to FeatureBase Cloud, you will need the user name and password that you configured during signup. You can obtain a JWT token by making a POST request against https://id.featurebase.com. For example:

curl --location --request POST 'https://id.featurebase.com' \
     --header 'Content-Type: application/json' \
     --data-raw '{"USERNAME":"john.doe@example.com","PASSWORD":"secretpassword"}' 

If successful, you will receive a JWT access token in the response. For example:

{
  "AuthenticationResult": {
    "AccessToken": "ey..g",
    "ExpiresIn": 3600,
    "IdToken": "ey..w",
    "RefreshToken": "ey..A",
    "TokenType": "Bearer"
  }
}

In order to authenticate against FeatureBase Cloud API endpoints, you should pass in the IdToken above as the value of the Authorization header with the Bearer scheme when making HTTP requests. For example, to list databases in your organization:

curl --location --request POST 'https://api.featurebase.com/v1/deployments/' \
     --header 'Authorization: Bearer ey..w' \
     --header 'Content-Type: application/json'

HTTP Authorization Scheme: bearer

Bearer format: JWT

API Key: ApiKeyAuth

Customers can generate API keys and use them to perform API actions in lieu of JWT tokens. Keys can only be created by their owners, they can be revoked by org administrators and by their owners, however they cannot be deleted. Once a key is revoked, it cannot be unrevoked. Keys will never expire, they need to be explicitly revoked when no longer needed.

To authenticate with an API key simply pass it using the X-API-Key header. e.g.:

curl --location --request GET 'https://api.featurebase.com/v2/databases' --header 'X-API-Key: <key secret>'

Once keys are generated their secret cannot be recovered, even by FeatureBase staff.

Header parameter name: X-API-Key

The following table describes each database state:

Database Status	Definition	Can query data
CREATING	FeatureBase Cloud has received the signal to start provisioning a database.	No
PROVISIONING	A database is being created.	No
RUNNING	Database is running normally. Users may run queries.	Yes
RESTORING	Restoring data from a backup.	No
BACKUP	Creating a backup of the database.	Yes
DELETING	FeatureBase Cloud has received the signal to start deprovisioning a database.	No
DEPROVISIONING	Database is being deprovisioned (deleted).	No
DELETED	Deprovision completed successfully.	No
FAILED	Unrecoverable. Data is lost or Database failed to be provisioned.	No
FROZEN	There was a problem with backup and no new operations can be done on the database.	No
UPDATING	The database is being updated, some performance degradation might occur but all data is available	Yes

• FeatureBase Documentation
• FeatureBase Trial Sign Up
• FeatureBase Login

Databases embody FeatureBase clusters launched as a managed service in the FeatureBase Cloud. For table creation in a database please refer to https://docs.featurebase.com/docs/sql-guide/statements/statement-table-create/