Databases

PostgreSQL, MySQL, MariaDB, MongoDB, Redis and libSQL databases: create, deploy, start, stop and delete.

Each database engine has the same set of routes under its own prefix. PostgreSQL, MySQL and Redis can also run in a Cloud account (RDS, Cloud SQL, ElastiCache, Memorystore) or stand for an existing database made outside Cloudgate.

Every request goes to https://cloudgate.octabyte.app/backend on the Hosted instance, or to your console address followed by /backend when you self-host. Send a Personal key in x-api-key and the Organization in x-organization-id; Authentication shows how to make the key, and Errors explains every refusal. The examples setCLOUDGATE_KEY and CLOUDGATE_ORG_ID in the shell first. To do the same in the console, read Databases in the user guide.

PostgreSQL

Create a PostgreSQL database

POST/postgres

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`name`required	string	1 to 100 characters.
`appName`	string	1 to 63 characters. Matches `^[a-zA-Z0-9_][a-zA-Z0-9._-]*$`.
`databaseName`required	string	1 to 63 characters. Matches `^[A-Za-z_][A-Za-z0-9_]*$`.
`databaseUser`required	string	1 to 63 characters. Matches `^[A-Za-z_][A-Za-z0-9_]*$`.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`description`	string
`environmentId`required	string	Not empty.
`serverId`	string or null

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "orders-db",
    "databaseName": "example",
    "databaseUser": "example",
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc"
  }'

Use an existing PostgreSQL database

POST/postgres/existing

"Use an existing database": the Environment's entry stands for an RDS instance the operator already has.

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`environmentId`required	string	Not empty.
`configName`required	string	Matches `^[a-z][a-z0-9-]{0,62}$`.
`identifier`required	string
`databaseUser`required	string	1 to 63 characters.
`databasePassword`required	string	1 to 128 characters.
`databaseName`required	string	1 to 63 characters.
`madeReachable`	boolean	Default `false`.

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc",
    "configName": "example",
    "identifier": "example",
    "databaseUser": "example",
    "databasePassword": "<secret>",
    "databaseName": "example"
  }'

Read reach for an existing PostgreSQL database

GET/postgres/existing/reach

What the "Use an existing database" form shows: where this Environment's Services reach a database from, to let in.

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`environmentId`required	query	string	Not empty.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl "https://cloudgate.octabyte.app/backend/postgres/existing/reach?environmentId=UVFRqyCfWEtSm6NdDvrZc" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update an existing PostgreSQL database

PATCH/postgres/{id}/existing

An Existing database's login, identifier or tick.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`identifier`	string
`databaseUser`	string	1 to 63 characters.
`databasePassword`	string	1 to 128 characters.
`databaseName`	string	1 to 63 characters.
`madeReachable`	boolean

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "identifier": "example",
    "databaseUser": "example",
    "databasePassword": "<secret>"
  }'

Switch to an existing PostgreSQL database

POST/postgres/{id}/switch/to-existing

A switch between a Cloudgate-made and an existing database, asked for on the Service's page: to-existing takes what "Use an existing database" takes, to-made nothing. Nothing changes until the next plan's Apply, which removes one Service and adds the other — its destroy confirmed by name, as any.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`identifier`required	string
`databaseUser`required	string	1 to 63 characters.
`databasePassword`required	string	1 to 128 characters.
`databaseName`required	string	1 to 63 characters.
`madeReachable`	boolean	Default `false`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/switch/to-existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "identifier": "example",
    "databaseUser": "example",
    "databasePassword": "<secret>",
    "databaseName": "example"
  }'

Switch to a Cloudgate-made PostgreSQL database

POST/postgres/{id}/switch/to-made

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/switch/to-made \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Cancel the switch of a PostgreSQL database

DELETE/postgres/{id}/switch

Cancels a switch no Apply has made yet.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/switch \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Deploy a PostgreSQL database

POST/postgres/{id}/deploy

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/deploy \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Get a PostgreSQL database

GET/postgres/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update a PostgreSQL database

PATCH/postgres/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`name`	string	1 to 100 characters.
`description`	string or null
`databaseName`	string	Not empty.
`databaseUser`	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`command`	string or null
`args`	array of string or null
`memoryReservation`	string or null
`memoryLimit`	string or null
`cpuReservation`	string or null
`cpuLimit`	string or null
`replicas`	integer	At least 0.
`healthCheckSwarm`	object or null
`healthCheckSwarm.Test`	array of string
`healthCheckSwarm.Interval`	number
`healthCheckSwarm.Timeout`	number
`healthCheckSwarm.StartPeriod`	number
`healthCheckSwarm.Retries`	number
`restartPolicySwarm`	object or null
`restartPolicySwarm.Condition`	string
`restartPolicySwarm.Delay`	number
`restartPolicySwarm.MaxAttempts`	number
`restartPolicySwarm.Window`	number
`placementSwarm`	object or null
`placementSwarm.Constraints`	array of string
`placementSwarm.Preferences`	array of object
`placementSwarm.Preferences[].Spread`required	object
`placementSwarm.MaxReplicas`	number
`placementSwarm.Platforms`	array of object
`placementSwarm.Platforms[].Architecture`required	string
`placementSwarm.Platforms[].OS`required	string
`updateConfigSwarm`	object or null
`updateConfigSwarm.Parallelism`required	number
`updateConfigSwarm.Delay`	number
`updateConfigSwarm.FailureAction`	string
`updateConfigSwarm.Monitor`	number
`updateConfigSwarm.MaxFailureRatio`	number
`updateConfigSwarm.Order`required	string
`rollbackConfigSwarm`	object or null
`rollbackConfigSwarm.Parallelism`required	number
`rollbackConfigSwarm.Delay`	number
`rollbackConfigSwarm.FailureAction`	string
`rollbackConfigSwarm.Monitor`	number
`rollbackConfigSwarm.MaxFailureRatio`	number
`rollbackConfigSwarm.Order`required	string
`modeSwarm`	object or null
`modeSwarm.Replicated`	object
`modeSwarm.Replicated.Replicas`	number
`modeSwarm.Global`	object
`modeSwarm.ReplicatedJob`	object
`modeSwarm.ReplicatedJob.MaxConcurrent`	number
`modeSwarm.ReplicatedJob.TotalCompletions`	number
`modeSwarm.GlobalJob`	object
`labelsSwarm`	map of string or null
`networkSwarm`	array of object or null
`networkSwarm[].Target`	string
`networkSwarm[].Aliases`	array of string
`networkSwarm[].DriverOpts`	map of string
`stopGracePeriodSwarm`	number or null
`endpointSpecSwarm`	object or null
`endpointSpecSwarm.Mode`	string
`endpointSpecSwarm.Ports`	array of object
`endpointSpecSwarm.Ports[].Protocol`	string
`endpointSpecSwarm.Ports[].TargetPort`	number
`endpointSpecSwarm.Ports[].PublishedPort`	number
`endpointSpecSwarm.Ports[].PublishMode`	string
`ulimitsSwarm`	array of object or null
`ulimitsSwarm[].Name`required	string
`ulimitsSwarm[].Soft`required	number
`ulimitsSwarm[].Hard`required	number

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "orders-db",
    "description": "Storefront for Northwind Labs",
    "databaseName": "example"
  }'

Delete a PostgreSQL database

DELETE/postgres/{id}

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.
`force`required	query	string
`deleteData`required	query	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE "https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC?force=example&deleteData=example" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save RDS settings of a PostgreSQL database

PATCH/postgres/{id}/rds-settings

Cloudgate's own settings of a postgres on RDS: its class when the entry has no size, storage and its ceiling, Multi-AZ and backup retention, applied by the next plan's Apply.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`instanceClass`	string	Not empty.
`storageGb`	integer	20 to 65536.
`maxStorageGb`	integer	20 to 65536.
`multiAz`	boolean
`backupRetentionDays`	integer	1 to 35.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/rds-settings \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "instanceClass": "example",
    "storageGb": 20,
    "maxStorageGb": 20
  }'

Save Cloud SQL settings of a PostgreSQL database

PATCH/postgres/{id}/cloud-sql-settings

Cloudgate's own setting of a postgres on Cloud SQL: its backup retention, 1 to 365 days, edited on its Backups tab and applied by the next plan's Apply. Refused for a postgres anywhere else.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`backupRetentionDays`required	integer	1 to 365.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/cloud-sql-settings \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "backupRetentionDays": 1
  }'

List cloud backups of a PostgreSQL database

GET/postgres/{id}/cloud-backups

A postgres in a Cloud account's Backups tab: its retention, the window a restore reaches and its snapshots or backups, read live from RDS or Cloud SQL.

Who can call it: Owner, Admin or Member. Needs backup: read, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/cloud-backups \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save the environment variables of a PostgreSQL database

PATCH/postgres/{id}/environment

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`env`required	string or null

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/environment \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "env": "NODE_ENV=production"
  }'

Change status of a PostgreSQL database

POST/postgres/{id}/status

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`applicationStatus`required	string	One of `idle`, `running`, `done`, `error`, `stopped`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/status \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "applicationStatus": "idle"
  }'

Check the data volume of a PostgreSQL database

GET/postgres/{id}/volume

Whether <appName>-data is on the Server now, for the Delete dialog. present is null when it cannot be known — a multi-node swarm, or a Server that did not answer.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/volume \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Preview the final snapshot of a PostgreSQL database

GET/postgres/{id}/final-snapshot

The final snapshot a Delete pressed now keeps, and about what it costs a month, for the Delete dialog of a database in a Cloud account.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/final-snapshot \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Retry deleting a PostgreSQL database

POST/postgres/{id}/delete/retry

Retry a cloud database's incomplete Delete: another destroy-only Cloud run from the kept state.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/delete/retry \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Forget the incomplete delete of a PostgreSQL database

POST/postgres/{id}/delete/forget

Forget a cloud database's incomplete Delete: the row dropped, what is left in AWS written into the audit entry.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/delete/forget \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Set the external port of a PostgreSQL database

POST/postgres/{id}/external-port

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Request body

Field	Type	Notes
`externalPort`required	integer or null	1 to 65535.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/external-port \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "externalPort": 3000
  }'

Rebuild a PostgreSQL database

POST/postgres/{id}/rebuild

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/rebuild \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Start a PostgreSQL database

POST/postgres/{id}/start

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/start \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Stop a PostgreSQL database

POST/postgres/{id}/stop

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The PostgreSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/postgres/RAU6yAYUXFRdXdPLyLoPC/stop \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

MySQL

Create a MySQL database

POST/mysql

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`name`required	string	1 to 100 characters.
`appName`	string	1 to 63 characters. Matches `^[a-zA-Z0-9_][a-zA-Z0-9._-]*$`.
`databaseName`required	string	1 to 64 characters. Matches `^[A-Za-z_][A-Za-z0-9_]*$`.
`databaseUser`required	string	1 to 32 characters. Matches `^[A-Za-z_][A-Za-z0-9_]*$`.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`databaseRootPassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`description`	string
`environmentId`required	string	Not empty.
`serverId`	string or null

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "catalog-db",
    "databaseName": "example",
    "databaseUser": "example",
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc"
  }'

Use an existing MySQL database

POST/mysql/existing

"Use an existing database": the Environment's entry stands for an RDS instance the operator already has.

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`environmentId`required	string	Not empty.
`configName`required	string	Matches `^[a-z][a-z0-9-]{0,62}$`.
`identifier`required	string
`databaseUser`required	string	1 to 63 characters.
`databasePassword`required	string	1 to 128 characters.
`databaseName`required	string	1 to 63 characters.
`madeReachable`	boolean	Default `false`.

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc",
    "configName": "example",
    "identifier": "example",
    "databaseUser": "example",
    "databasePassword": "<secret>",
    "databaseName": "example"
  }'

Read reach for an existing MySQL database

GET/mysql/existing/reach

What the "Use an existing database" form shows: where this Environment's Services reach a database from, to let in.

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`environmentId`required	query	string	Not empty.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl "https://cloudgate.octabyte.app/backend/mysql/existing/reach?environmentId=UVFRqyCfWEtSm6NdDvrZc" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update an existing MySQL database

PATCH/mysql/{id}/existing

An Existing database's login, identifier or tick.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`identifier`	string
`databaseUser`	string	1 to 63 characters.
`databasePassword`	string	1 to 128 characters.
`databaseName`	string	1 to 63 characters.
`madeReachable`	boolean

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "identifier": "example",
    "databaseUser": "example",
    "databasePassword": "<secret>"
  }'

Switch to an existing MySQL database

POST/mysql/{id}/switch/to-existing

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`identifier`required	string
`databaseUser`required	string	1 to 63 characters.
`databasePassword`required	string	1 to 128 characters.
`databaseName`required	string	1 to 63 characters.
`madeReachable`	boolean	Default `false`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/switch/to-existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "identifier": "example",
    "databaseUser": "example",
    "databasePassword": "<secret>",
    "databaseName": "example"
  }'

Switch to a Cloudgate-made MySQL database

POST/mysql/{id}/switch/to-made

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/switch/to-made \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Cancel the switch of a MySQL database

DELETE/mysql/{id}/switch

Cancels a switch no Apply has made yet.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/switch \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Deploy a MySQL database

POST/mysql/{id}/deploy

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/deploy \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Get a MySQL database

GET/mysql/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update a MySQL database

PATCH/mysql/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`name`	string	1 to 100 characters.
`description`	string or null
`databaseName`	string	Not empty.
`databaseUser`	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`databaseRootPassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`command`	string or null
`args`	array of string or null
`memoryReservation`	string or null
`memoryLimit`	string or null
`cpuReservation`	string or null
`cpuLimit`	string or null
`replicas`	integer	At least 0.
`healthCheckSwarm`	object or null
`healthCheckSwarm.Test`	array of string
`healthCheckSwarm.Interval`	number
`healthCheckSwarm.Timeout`	number
`healthCheckSwarm.StartPeriod`	number
`healthCheckSwarm.Retries`	number
`restartPolicySwarm`	object or null
`restartPolicySwarm.Condition`	string
`restartPolicySwarm.Delay`	number
`restartPolicySwarm.MaxAttempts`	number
`restartPolicySwarm.Window`	number
`placementSwarm`	object or null
`placementSwarm.Constraints`	array of string
`placementSwarm.Preferences`	array of object
`placementSwarm.Preferences[].Spread`required	object
`placementSwarm.MaxReplicas`	number
`placementSwarm.Platforms`	array of object
`placementSwarm.Platforms[].Architecture`required	string
`placementSwarm.Platforms[].OS`required	string
`updateConfigSwarm`	object or null
`updateConfigSwarm.Parallelism`required	number
`updateConfigSwarm.Delay`	number
`updateConfigSwarm.FailureAction`	string
`updateConfigSwarm.Monitor`	number
`updateConfigSwarm.MaxFailureRatio`	number
`updateConfigSwarm.Order`required	string
`rollbackConfigSwarm`	object or null
`rollbackConfigSwarm.Parallelism`required	number
`rollbackConfigSwarm.Delay`	number
`rollbackConfigSwarm.FailureAction`	string
`rollbackConfigSwarm.Monitor`	number
`rollbackConfigSwarm.MaxFailureRatio`	number
`rollbackConfigSwarm.Order`required	string
`modeSwarm`	object or null
`modeSwarm.Replicated`	object
`modeSwarm.Replicated.Replicas`	number
`modeSwarm.Global`	object
`modeSwarm.ReplicatedJob`	object
`modeSwarm.ReplicatedJob.MaxConcurrent`	number
`modeSwarm.ReplicatedJob.TotalCompletions`	number
`modeSwarm.GlobalJob`	object
`labelsSwarm`	map of string or null
`networkSwarm`	array of object or null
`networkSwarm[].Target`	string
`networkSwarm[].Aliases`	array of string
`networkSwarm[].DriverOpts`	map of string
`stopGracePeriodSwarm`	number or null
`endpointSpecSwarm`	object or null
`endpointSpecSwarm.Mode`	string
`endpointSpecSwarm.Ports`	array of object
`endpointSpecSwarm.Ports[].Protocol`	string
`endpointSpecSwarm.Ports[].TargetPort`	number
`endpointSpecSwarm.Ports[].PublishedPort`	number
`endpointSpecSwarm.Ports[].PublishMode`	string
`ulimitsSwarm`	array of object or null
`ulimitsSwarm[].Name`required	string
`ulimitsSwarm[].Soft`required	number
`ulimitsSwarm[].Hard`required	number

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "catalog-db",
    "description": "Storefront for Northwind Labs",
    "databaseName": "example"
  }'

Delete a MySQL database

DELETE/mysql/{id}

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.
`force`required	query	string
`deleteData`required	query	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE "https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC?force=example&deleteData=example" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save RDS settings of a MySQL database

PATCH/mysql/{id}/rds-settings

Cloudgate's own settings of a mysql on RDS, as a postgres's: its class when the entry has no size, storage and its ceiling, Multi-AZ and backup retention, applied by the next plan's Apply.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`instanceClass`	string	Not empty.
`storageGb`	integer	20 to 65536.
`maxStorageGb`	integer	20 to 65536.
`multiAz`	boolean
`backupRetentionDays`	integer	1 to 35.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/rds-settings \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "instanceClass": "example",
    "storageGb": 20,
    "maxStorageGb": 20
  }'

Save Cloud SQL settings of a MySQL database

PATCH/mysql/{id}/cloud-sql-settings

Cloudgate's own setting of a mysql on Cloud SQL, as a postgres's: its backup retention, 1 to 365 days, edited on its Backups tab and applied by the next plan's Apply. Refused for a mysql anywhere else.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`backupRetentionDays`required	integer	1 to 365.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/cloud-sql-settings \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "backupRetentionDays": 1
  }'

List cloud backups of a MySQL database

GET/mysql/{id}/cloud-backups

A mysql in a Cloud account's Backups tab, as a postgres's: its retention, the window point-in-time restore reaches and its snapshots or backups, read live from RDS or Cloud SQL.

Who can call it: Owner, Admin or Member. Needs backup: read, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/cloud-backups \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save the environment variables of a MySQL database

PATCH/mysql/{id}/environment

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`env`required	string or null

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/environment \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "env": "NODE_ENV=production"
  }'

Change status of a MySQL database

POST/mysql/{id}/status

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`applicationStatus`required	string	One of `idle`, `running`, `done`, `error`, `stopped`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/status \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "applicationStatus": "idle"
  }'

Check the data volume of a MySQL database

GET/mysql/{id}/volume

Whether <appName>-data is on the Server now, for the Delete dialog. present is null when it cannot be known — a multi-node swarm, or a Server that did not answer.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/volume \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Preview the final snapshot of a MySQL database

GET/mysql/{id}/final-snapshot

The final snapshot a Delete pressed now keeps, and about what it costs a month, for the Delete dialog of a database in a Cloud account.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/final-snapshot \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Retry deleting a MySQL database

POST/mysql/{id}/delete/retry

Retry a cloud database's incomplete Delete: another destroy-only Cloud run from the kept state.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/delete/retry \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Forget the incomplete delete of a MySQL database

POST/mysql/{id}/delete/forget

Forget a cloud database's incomplete Delete: the row dropped, what is left in AWS written into the audit entry.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/delete/forget \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Set the external port of a MySQL database

POST/mysql/{id}/external-port

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Request body

Field	Type	Notes
`externalPort`required	integer or null	1 to 65535.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/external-port \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "externalPort": 3000
  }'

Rebuild a MySQL database

POST/mysql/{id}/rebuild

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/rebuild \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Start a MySQL database

POST/mysql/{id}/start

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/start \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Stop a MySQL database

POST/mysql/{id}/stop

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MySQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mysql/RAU6yAYUXFRdXdPLyLoPC/stop \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

MariaDB

Create a MariaDB database

POST/mariadb

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`name`required	string	1 to 100 characters.
`appName`	string	1 to 63 characters. Matches `^[a-zA-Z0-9_][a-zA-Z0-9._-]*$`.
`databaseName`required	string	1 to 64 characters. Matches `^[A-Za-z_][A-Za-z0-9_]*$`.
`databaseUser`required	string	1 to 80 characters. Matches `^[A-Za-z_][A-Za-z0-9_]*$`.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`databaseRootPassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`description`	string
`environmentId`required	string	Not empty.
`serverId`	string or null

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "catalog-db",
    "databaseName": "example",
    "databaseUser": "example",
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc"
  }'

Deploy a MariaDB database

POST/mariadb/{id}/deploy

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/deploy \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Get a MariaDB database

GET/mariadb/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update a MariaDB database

PATCH/mariadb/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Request body

Field	Type	Notes
`name`	string	1 to 100 characters.
`description`	string or null
`databaseName`	string	Not empty.
`databaseUser`	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`databaseRootPassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`command`	string or null
`args`	array of string or null
`memoryReservation`	string or null
`memoryLimit`	string or null
`cpuReservation`	string or null
`cpuLimit`	string or null
`replicas`	integer	At least 0.
`healthCheckSwarm`	object or null
`healthCheckSwarm.Test`	array of string
`healthCheckSwarm.Interval`	number
`healthCheckSwarm.Timeout`	number
`healthCheckSwarm.StartPeriod`	number
`healthCheckSwarm.Retries`	number
`restartPolicySwarm`	object or null
`restartPolicySwarm.Condition`	string
`restartPolicySwarm.Delay`	number
`restartPolicySwarm.MaxAttempts`	number
`restartPolicySwarm.Window`	number
`placementSwarm`	object or null
`placementSwarm.Constraints`	array of string
`placementSwarm.Preferences`	array of object
`placementSwarm.Preferences[].Spread`required	object
`placementSwarm.MaxReplicas`	number
`placementSwarm.Platforms`	array of object
`placementSwarm.Platforms[].Architecture`required	string
`placementSwarm.Platforms[].OS`required	string
`updateConfigSwarm`	object or null
`updateConfigSwarm.Parallelism`required	number
`updateConfigSwarm.Delay`	number
`updateConfigSwarm.FailureAction`	string
`updateConfigSwarm.Monitor`	number
`updateConfigSwarm.MaxFailureRatio`	number
`updateConfigSwarm.Order`required	string
`rollbackConfigSwarm`	object or null
`rollbackConfigSwarm.Parallelism`required	number
`rollbackConfigSwarm.Delay`	number
`rollbackConfigSwarm.FailureAction`	string
`rollbackConfigSwarm.Monitor`	number
`rollbackConfigSwarm.MaxFailureRatio`	number
`rollbackConfigSwarm.Order`required	string
`modeSwarm`	object or null
`modeSwarm.Replicated`	object
`modeSwarm.Replicated.Replicas`	number
`modeSwarm.Global`	object
`modeSwarm.ReplicatedJob`	object
`modeSwarm.ReplicatedJob.MaxConcurrent`	number
`modeSwarm.ReplicatedJob.TotalCompletions`	number
`modeSwarm.GlobalJob`	object
`labelsSwarm`	map of string or null
`networkSwarm`	array of object or null
`networkSwarm[].Target`	string
`networkSwarm[].Aliases`	array of string
`networkSwarm[].DriverOpts`	map of string
`stopGracePeriodSwarm`	number or null
`endpointSpecSwarm`	object or null
`endpointSpecSwarm.Mode`	string
`endpointSpecSwarm.Ports`	array of object
`endpointSpecSwarm.Ports[].Protocol`	string
`endpointSpecSwarm.Ports[].TargetPort`	number
`endpointSpecSwarm.Ports[].PublishedPort`	number
`endpointSpecSwarm.Ports[].PublishMode`	string
`ulimitsSwarm`	array of object or null
`ulimitsSwarm[].Name`required	string
`ulimitsSwarm[].Soft`required	number
`ulimitsSwarm[].Hard`required	number

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "catalog-db",
    "description": "Storefront for Northwind Labs",
    "databaseName": "example"
  }'

Delete a MariaDB database

DELETE/mariadb/{id}

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.
`force`required	query	string
`deleteData`required	query	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE "https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC?force=example&deleteData=example" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save the environment variables of a MariaDB database

PATCH/mariadb/{id}/environment

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Request body

Field	Type	Notes
`env`required	string or null

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/environment \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "env": "NODE_ENV=production"
  }'

Change status of a MariaDB database

POST/mariadb/{id}/status

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Request body

Field	Type	Notes
`applicationStatus`required	string	One of `idle`, `running`, `done`, `error`, `stopped`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/status \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "applicationStatus": "idle"
  }'

Check the data volume of a MariaDB database

GET/mariadb/{id}/volume

Whether <appName>-data is on the Server now, for the Delete dialog. present is null when it cannot be known — a multi-node swarm, or a Server that did not answer.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/volume \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Set the external port of a MariaDB database

POST/mariadb/{id}/external-port

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Request body

Field	Type	Notes
`externalPort`required	integer or null	1 to 65535.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/external-port \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "externalPort": 3000
  }'

Rebuild a MariaDB database

POST/mariadb/{id}/rebuild

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/rebuild \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Start a MariaDB database

POST/mariadb/{id}/start

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/start \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Stop a MariaDB database

POST/mariadb/{id}/stop

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MariaDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mariadb/RAU6yAYUXFRdXdPLyLoPC/stop \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

MongoDB

Create a MongoDB database

POST/mongo

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`name`required	string	1 to 100 characters.
`appName`	string	1 to 63 characters. Matches `^[a-zA-Z0-9_][a-zA-Z0-9._-]*$`.
`databaseUser`required	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`description`	string
`replicaSets`	boolean
`environmentId`required	string	Not empty.
`serverId`	string or null

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "events-db",
    "databaseUser": "example",
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc"
  }'

Deploy a MongoDB database

POST/mongo/{id}/deploy

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/deploy \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Get a MongoDB database

GET/mongo/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update a MongoDB database

PATCH/mongo/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Request body

Field	Type	Notes
`name`	string	1 to 100 characters.
`description`	string or null
`databaseUser`	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`command`	string or null
`args`	array of string or null
`replicaSets`	boolean
`memoryReservation`	string or null
`memoryLimit`	string or null
`cpuReservation`	string or null
`cpuLimit`	string or null
`replicas`	integer	At least 0.
`healthCheckSwarm`	object or null
`healthCheckSwarm.Test`	array of string
`healthCheckSwarm.Interval`	number
`healthCheckSwarm.Timeout`	number
`healthCheckSwarm.StartPeriod`	number
`healthCheckSwarm.Retries`	number
`restartPolicySwarm`	object or null
`restartPolicySwarm.Condition`	string
`restartPolicySwarm.Delay`	number
`restartPolicySwarm.MaxAttempts`	number
`restartPolicySwarm.Window`	number
`placementSwarm`	object or null
`placementSwarm.Constraints`	array of string
`placementSwarm.Preferences`	array of object
`placementSwarm.Preferences[].Spread`required	object
`placementSwarm.MaxReplicas`	number
`placementSwarm.Platforms`	array of object
`placementSwarm.Platforms[].Architecture`required	string
`placementSwarm.Platforms[].OS`required	string
`updateConfigSwarm`	object or null
`updateConfigSwarm.Parallelism`required	number
`updateConfigSwarm.Delay`	number
`updateConfigSwarm.FailureAction`	string
`updateConfigSwarm.Monitor`	number
`updateConfigSwarm.MaxFailureRatio`	number
`updateConfigSwarm.Order`required	string
`rollbackConfigSwarm`	object or null
`rollbackConfigSwarm.Parallelism`required	number
`rollbackConfigSwarm.Delay`	number
`rollbackConfigSwarm.FailureAction`	string
`rollbackConfigSwarm.Monitor`	number
`rollbackConfigSwarm.MaxFailureRatio`	number
`rollbackConfigSwarm.Order`required	string
`modeSwarm`	object or null
`modeSwarm.Replicated`	object
`modeSwarm.Replicated.Replicas`	number
`modeSwarm.Global`	object
`modeSwarm.ReplicatedJob`	object
`modeSwarm.ReplicatedJob.MaxConcurrent`	number
`modeSwarm.ReplicatedJob.TotalCompletions`	number
`modeSwarm.GlobalJob`	object
`labelsSwarm`	map of string or null
`networkSwarm`	array of object or null
`networkSwarm[].Target`	string
`networkSwarm[].Aliases`	array of string
`networkSwarm[].DriverOpts`	map of string
`stopGracePeriodSwarm`	number or null
`endpointSpecSwarm`	object or null
`endpointSpecSwarm.Mode`	string
`endpointSpecSwarm.Ports`	array of object
`endpointSpecSwarm.Ports[].Protocol`	string
`endpointSpecSwarm.Ports[].TargetPort`	number
`endpointSpecSwarm.Ports[].PublishedPort`	number
`endpointSpecSwarm.Ports[].PublishMode`	string
`ulimitsSwarm`	array of object or null
`ulimitsSwarm[].Name`required	string
`ulimitsSwarm[].Soft`required	number
`ulimitsSwarm[].Hard`required	number

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "events-db",
    "description": "Storefront for Northwind Labs",
    "databaseUser": "example"
  }'

Delete a MongoDB database

DELETE/mongo/{id}

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.
`force`required	query	string
`deleteData`required	query	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE "https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC?force=example&deleteData=example" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save the environment variables of a MongoDB database

PATCH/mongo/{id}/environment

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Request body

Field	Type	Notes
`env`required	string or null

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/environment \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "env": "NODE_ENV=production"
  }'

Change status of a MongoDB database

POST/mongo/{id}/status

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Request body

Field	Type	Notes
`applicationStatus`required	string	One of `idle`, `running`, `done`, `error`, `stopped`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/status \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "applicationStatus": "idle"
  }'

Check the data volume of a MongoDB database

GET/mongo/{id}/volume

Whether <appName>-data is on the Server now, for the Delete dialog. present is null when it cannot be known — a multi-node swarm, or a Server that did not answer.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/volume \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Set the external port of a MongoDB database

POST/mongo/{id}/external-port

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Request body

Field	Type	Notes
`externalPort`required	integer or null	1 to 65535.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/external-port \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "externalPort": 3000
  }'

Rebuild a MongoDB database

POST/mongo/{id}/rebuild

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/rebuild \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Start a MongoDB database

POST/mongo/{id}/start

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/start \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Stop a MongoDB database

POST/mongo/{id}/stop

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The MongoDB database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/mongo/RAU6yAYUXFRdXdPLyLoPC/stop \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Redis

List cloud backups of a Redis database

GET/redis/{id}/cloud-backups

A redis on ElastiCache's Backups tab: its snapshot retention and snapshots, read live from ElastiCache.

Who can call it: Owner, Admin or Member. Needs backup: read, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/cloud-backups \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Create a Redis database

POST/redis

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`name`required	string	1 to 100 characters.
`appName`	string	1 to 63 characters. Matches `^[a-zA-Z0-9_][a-zA-Z0-9._-]*$`.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`description`	string
`environmentId`required	string	Not empty.
`serverId`	string or null

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "sessions",
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc"
  }'

Use an existing Redis database

POST/redis/existing

"Use an existing database" for a redis: the Environment's entry stands for an ElastiCache replication group the operator already has.

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`environmentId`required	string	Not empty.
`configName`required	string	Matches `^[a-z][a-z0-9-]{0,62}$`.
`identifier`required	string
`authToken`	string or ""	Default `""`.
`tls`	boolean	Default `true`.
`madeReachable`	boolean	Default `false`.

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc",
    "configName": "example",
    "identifier": "example"
  }'

Read reach for an existing Redis database

GET/redis/existing/reach

What the "Use an existing database" form shows: where this Environment's Services reach a cache from, to let in.

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`environmentId`required	query	string	Not empty.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl "https://cloudgate.octabyte.app/backend/redis/existing/reach?environmentId=UVFRqyCfWEtSm6NdDvrZc" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update an existing Redis database

PATCH/redis/{id}/existing

An Existing cache's replication group id, AUTH token, TLS flag or tick.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`identifier`	string
`authToken`	string or ""
`tls`	boolean
`madeReachable`	boolean

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "identifier": "example",
    "authToken": "<secret>",
    "tls": true
  }'

Switch to an existing Redis database

POST/redis/{id}/switch/to-existing

A switch between a Cloudgate-made and an existing cache, asked for on the Service's page: to-existing takes what "Use an existing cache" takes, to-made nothing. Nothing changes until the next plan's Apply, which removes one Service and adds the other — its destroy confirmed by name, as any.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`identifier`required	string
`authToken`	string or ""	Default `""`.
`tls`	boolean	Default `true`.
`madeReachable`	boolean	Default `false`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/switch/to-existing \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "identifier": "example"
  }'

Switch to a Cloudgate-made Redis database

POST/redis/{id}/switch/to-made

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/switch/to-made \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Cancel the switch of a Redis database

DELETE/redis/{id}/switch

Cancels a switch no Apply has made yet.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/switch \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Deploy a Redis database

POST/redis/{id}/deploy

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/deploy \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Get a Redis database

GET/redis/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update a Redis database

PATCH/redis/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`name`	string	1 to 100 characters.
`description`	string or null
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`command`	string or null
`args`	array of string or null
`memoryReservation`	string or null
`memoryLimit`	string or null
`cpuReservation`	string or null
`cpuLimit`	string or null
`replicas`	integer	At least 0.
`healthCheckSwarm`	object or null
`healthCheckSwarm.Test`	array of string
`healthCheckSwarm.Interval`	number
`healthCheckSwarm.Timeout`	number
`healthCheckSwarm.StartPeriod`	number
`healthCheckSwarm.Retries`	number
`restartPolicySwarm`	object or null
`restartPolicySwarm.Condition`	string
`restartPolicySwarm.Delay`	number
`restartPolicySwarm.MaxAttempts`	number
`restartPolicySwarm.Window`	number
`placementSwarm`	object or null
`placementSwarm.Constraints`	array of string
`placementSwarm.Preferences`	array of object
`placementSwarm.Preferences[].Spread`required	object
`placementSwarm.MaxReplicas`	number
`placementSwarm.Platforms`	array of object
`placementSwarm.Platforms[].Architecture`required	string
`placementSwarm.Platforms[].OS`required	string
`updateConfigSwarm`	object or null
`updateConfigSwarm.Parallelism`required	number
`updateConfigSwarm.Delay`	number
`updateConfigSwarm.FailureAction`	string
`updateConfigSwarm.Monitor`	number
`updateConfigSwarm.MaxFailureRatio`	number
`updateConfigSwarm.Order`required	string
`rollbackConfigSwarm`	object or null
`rollbackConfigSwarm.Parallelism`required	number
`rollbackConfigSwarm.Delay`	number
`rollbackConfigSwarm.FailureAction`	string
`rollbackConfigSwarm.Monitor`	number
`rollbackConfigSwarm.MaxFailureRatio`	number
`rollbackConfigSwarm.Order`required	string
`modeSwarm`	object or null
`modeSwarm.Replicated`	object
`modeSwarm.Replicated.Replicas`	number
`modeSwarm.Global`	object
`modeSwarm.ReplicatedJob`	object
`modeSwarm.ReplicatedJob.MaxConcurrent`	number
`modeSwarm.ReplicatedJob.TotalCompletions`	number
`modeSwarm.GlobalJob`	object
`labelsSwarm`	map of string or null
`networkSwarm`	array of object or null
`networkSwarm[].Target`	string
`networkSwarm[].Aliases`	array of string
`networkSwarm[].DriverOpts`	map of string
`stopGracePeriodSwarm`	number or null
`endpointSpecSwarm`	object or null
`endpointSpecSwarm.Mode`	string
`endpointSpecSwarm.Ports`	array of object
`endpointSpecSwarm.Ports[].Protocol`	string
`endpointSpecSwarm.Ports[].TargetPort`	number
`endpointSpecSwarm.Ports[].PublishedPort`	number
`endpointSpecSwarm.Ports[].PublishMode`	string
`ulimitsSwarm`	array of object or null
`ulimitsSwarm[].Name`required	string
`ulimitsSwarm[].Soft`required	number
`ulimitsSwarm[].Hard`required	number

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "sessions",
    "description": "Storefront for Northwind Labs",
    "databasePassword": "<secret>"
  }'

Delete a Redis database

DELETE/redis/{id}

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.
`force`required	query	string
`deleteData`required	query	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE "https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC?force=example&deleteData=example" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save ElastiCache settings of a Redis database

PATCH/redis/{id}/elasticache-settings

Cloudgate's own settings of a redis on ElastiCache: its node type when the entry has no size, the replica and snapshot retention, applied by the next plan's Apply.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`nodeType`	string	Not empty.
`replica`	boolean
`snapshotRetentionDays`	integer	0 to 35.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/elasticache-settings \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "nodeType": "example",
    "replica": true,
    "snapshotRetentionDays": 0
  }'

Save Memorystore settings of a Redis database

PATCH/redis/{id}/memorystore-settings

Cloudgate's own setting of a redis on Memorystore: high availability, a replica in another zone, applied by the next plan's Apply. Refused for a redis anywhere else.

Who can call it: Owner, Admin or Member. Needs service: update, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`highAvailability`	boolean
`backupRetentionDays`	integer	0 to 365.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/memorystore-settings \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "highAvailability": true,
    "backupRetentionDays": 0
  }'

Save the environment variables of a Redis database

PATCH/redis/{id}/environment

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`env`required	string or null

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/environment \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "env": "NODE_ENV=production"
  }'

Change status of a Redis database

POST/redis/{id}/status

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`applicationStatus`required	string	One of `idle`, `running`, `done`, `error`, `stopped`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/status \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "applicationStatus": "idle"
  }'

Check the data volume of a Redis database

GET/redis/{id}/volume

Whether <appName>-data is on the Server now, for the Delete dialog. present is null when it cannot be known — a multi-node swarm, or a Server that did not answer.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/volume \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Preview the final snapshot of a Redis database

GET/redis/{id}/final-snapshot

The final snapshot a Delete pressed now keeps, and about what it costs a month, for the Delete dialog of a database in a Cloud account.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/final-snapshot \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Retry deleting a Redis database

POST/redis/{id}/delete/retry

Retry a cloud database's incomplete Delete: another destroy-only Cloud run from the kept state.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/delete/retry \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Forget the incomplete delete of a Redis database

POST/redis/{id}/delete/forget

Forget a cloud database's incomplete Delete: the row dropped, what is left in AWS written into the audit entry.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/delete/forget \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Set the external port of a Redis database

POST/redis/{id}/external-port

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Request body

Field	Type	Notes
`externalPort`required	integer or null	1 to 65535.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/external-port \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "externalPort": 3000
  }'

Rebuild a Redis database

POST/redis/{id}/rebuild

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/rebuild \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Start a Redis database

POST/redis/{id}/start

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/start \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Stop a Redis database

POST/redis/{id}/stop

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The Redis database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/redis/RAU6yAYUXFRdXdPLyLoPC/stop \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

libSQL

Create a libSQL database

POST/libsql

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Request body

Field	Type	Notes
`name`required	string	1 to 100 characters.
`appName`	string	1 to 63 characters. Matches `^[a-zA-Z0-9_][a-zA-Z0-9._-]*$`.
`databaseUser`required	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`sqldNode`	string	One of `primary`, `replica`.
`sqldPrimaryUrl`	string or null
`enableNamespaces`	boolean
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`description`	string
`environmentId`required	string	Not empty.
`serverId`	string or null

Responses

201 Created: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "edge-db",
    "databaseUser": "example",
    "environmentId": "UVFRqyCfWEtSm6NdDvrZc"
  }'

Deploy a libSQL database

POST/libsql/{id}/deploy

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/deploy \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Get a libSQL database

GET/libsql/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Update a libSQL database

PATCH/libsql/{id}

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Request body

Field	Type	Notes
`name`	string	1 to 100 characters.
`description`	string or null
`databaseUser`	string	Not empty.
`databasePassword`	string	Matches `^[a-zA-Z0-9@#%^&()_+\-=[\]{}\|;:,.<>?~`]$`.
`sqldNode`	string	One of `primary`, `replica`.
`sqldPrimaryUrl`	string or null
`enableNamespaces`	boolean
`dockerImage`	string	Matches `^(?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]))\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)(?:\/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+))(?::[\w][\w.-]{0,127})?(?:@[A-Za-z][A-Za-z0-9](?:[-_+.][A-Za-z][A-Za-z0-9])*:[0-9a-fA-F]{32,})?$`.
`command`	string or null
`memoryReservation`	string or null
`memoryLimit`	string or null
`cpuReservation`	string or null
`cpuLimit`	string or null
`replicas`	integer	At least 0.
`healthCheckSwarm`	object or null
`healthCheckSwarm.Test`	array of string
`healthCheckSwarm.Interval`	number
`healthCheckSwarm.Timeout`	number
`healthCheckSwarm.StartPeriod`	number
`healthCheckSwarm.Retries`	number
`restartPolicySwarm`	object or null
`restartPolicySwarm.Condition`	string
`restartPolicySwarm.Delay`	number
`restartPolicySwarm.MaxAttempts`	number
`restartPolicySwarm.Window`	number
`placementSwarm`	object or null
`placementSwarm.Constraints`	array of string
`placementSwarm.Preferences`	array of object
`placementSwarm.Preferences[].Spread`required	object
`placementSwarm.MaxReplicas`	number
`placementSwarm.Platforms`	array of object
`placementSwarm.Platforms[].Architecture`required	string
`placementSwarm.Platforms[].OS`required	string
`updateConfigSwarm`	object or null
`updateConfigSwarm.Parallelism`required	number
`updateConfigSwarm.Delay`	number
`updateConfigSwarm.FailureAction`	string
`updateConfigSwarm.Monitor`	number
`updateConfigSwarm.MaxFailureRatio`	number
`updateConfigSwarm.Order`required	string
`rollbackConfigSwarm`	object or null
`rollbackConfigSwarm.Parallelism`required	number
`rollbackConfigSwarm.Delay`	number
`rollbackConfigSwarm.FailureAction`	string
`rollbackConfigSwarm.Monitor`	number
`rollbackConfigSwarm.MaxFailureRatio`	number
`rollbackConfigSwarm.Order`required	string
`modeSwarm`	object or null
`modeSwarm.Replicated`	object
`modeSwarm.Replicated.Replicas`	number
`modeSwarm.Global`	object
`modeSwarm.ReplicatedJob`	object
`modeSwarm.ReplicatedJob.MaxConcurrent`	number
`modeSwarm.ReplicatedJob.TotalCompletions`	number
`modeSwarm.GlobalJob`	object
`labelsSwarm`	map of string or null
`networkSwarm`	array of object or null
`networkSwarm[].Target`	string
`networkSwarm[].Aliases`	array of string
`networkSwarm[].DriverOpts`	map of string
`stopGracePeriodSwarm`	number or null
`endpointSpecSwarm`	object or null
`endpointSpecSwarm.Mode`	string
`endpointSpecSwarm.Ports`	array of object
`endpointSpecSwarm.Ports[].Protocol`	string
`endpointSpecSwarm.Ports[].TargetPort`	number
`endpointSpecSwarm.Ports[].PublishedPort`	number
`endpointSpecSwarm.Ports[].PublishMode`	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "edge-db",
    "description": "Storefront for Northwind Labs",
    "databaseUser": "example"
  }'

Delete a libSQL database

DELETE/libsql/{id}

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.
`force`required	query	string
`deleteData`required	query	string

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X DELETE "https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC?force=example&deleteData=example" \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Save the environment variables of a libSQL database

PATCH/libsql/{id}/environment

Who can call it: Any signed-in member. The route names no permission of its own; Cloudgate checks your role and your access to what it touches as it runs.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Request body

Field	Type	Notes
`env`required	string or null

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 You may not reach what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X PATCH https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/environment \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "env": "NODE_ENV=production"
  }'

Change status of a libSQL database

POST/libsql/{id}/status

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Request body

Field	Type	Notes
`applicationStatus`required	string	One of `idle`, `running`, `done`, `error`, `stopped`.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/status \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "applicationStatus": "idle"
  }'

Check the data volume of a libSQL database

GET/libsql/{id}/volume

Whether <appName>-data is on the Server now, for the Delete dialog. present is null when it cannot be known — a multi-node swarm, or a Server that did not answer.

Who can call it: Owner or Admin. Needs service: delete, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/volume \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Set the external ports of a libSQL database

POST/libsql/{id}/external-ports

Who can call it: Owner or Admin. Needs service: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Request body

Field	Type	Notes
`externalPort`required	integer or null	1 to 65535.
`externalGRPCPort`required	integer or null	1 to 65535.
`externalAdminPort`required	integer or null	1 to 65535.

Responses

200 OK: The result, as JSON.
Refusals: 400 Validation failed; details names each field; 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/external-ports \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID" \
  -H "content-type: application/json" \
  -d '{
    "externalPort": 3000,
    "externalGRPCPort": 3000,
    "externalAdminPort": 3000
  }'

Rebuild a libSQL database

POST/libsql/{id}/rebuild

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/rebuild \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Start a libSQL database

POST/libsql/{id}/start

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/start \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Stop a libSQL database

POST/libsql/{id}/stop

Who can call it: Owner, Admin or Member. Needs deployment: create, which a custom role can also grant.

Parameters

Name	In	Type	Notes
`id`required	path	string	The libSQL database's id.

Responses

200 OK: The result, as JSON.
Refusals: 401 No key, or the key is not valid; 403 Your role does not allow it, or you were not granted what it touches; 404 Nothing with that id in this Organization. The error body.

curl -X POST https://cloudgate.octabyte.app/backend/libsql/RAU6yAYUXFRdXdPLyLoPC/stop \
  -H "x-api-key: $CLOUDGATE_KEY" \
  -H "x-organization-id: $CLOUDGATE_ORG_ID"

Something missing or wrong on this page? Email support@octabyte.io, or start a free trial and try it in the console.