Update a database

PATCH

/api/databases/{id}

const url = 'https://example.com/api/databases/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","type":"example","databaseTypeId":"example","host":"example","port":1,"databaseName":"example","username":"example","password":"example","filePath":"example","useSsl":true,"serverId":"example","backupStorageType":"local","backupLocalPath":"example","backupSpacesBucket":"example","backupSpacesPrefix":"example","backupFormat":"plain","backupCompression":"none","backupCompressionLevel":1,"pgDumpOptions":{"noOwner":true,"clean":true,"ifExists":true,"schemaOnly":true,"dataOnly":true},"pgDumpTimeoutMs":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/api/databases/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "type": "example", "databaseTypeId": "example", "host": "example", "port": 1, "databaseName": "example", "username": "example", "password": "example", "filePath": "example", "useSsl": true, "serverId": "example", "backupStorageType": "local", "backupLocalPath": "example", "backupSpacesBucket": "example", "backupSpacesPrefix": "example", "backupFormat": "plain", "backupCompression": "none", "backupCompressionLevel": 1, "pgDumpOptions": { "noOwner": true, "clean": true, "ifExists": true, "schemaOnly": true, "dataOnly": true }, "pgDumpTimeoutMs": 1 }'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

name

string

>= 1 characters

type

string

>= 1 characters

databaseTypeId

string

host

string

port

number

databaseName

string

username

string

password

string

filePath

string

useSsl

boolean

serverId

string

backupStorageType

string

Allowed values: local spaces

backupLocalPath

string

backupSpacesBucket

string

backupSpacesPrefix

string

backupFormat

string

Allowed values: plain custom tar

backupCompression

string

Allowed values: none gzip

backupCompressionLevel

number

>= 1 <= 9

pgDumpOptions

object

noOwner

boolean

clean

boolean

ifExists

boolean

schemaOnly

boolean

dataOnly

boolean

pgDumpTimeoutMs

number

>= 30000 <= 3600000

Responses

400

Bad request — malformed input or failed validation.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

401

Unauthorized — missing or invalid bearer token.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

403

Forbidden — token scope or role does not permit this operation.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

404

Not found.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

422

Unprocessable — e.g. a read-only field was supplied.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

Update a database

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

400

Example

401

Example

403

Example

404

Example

422

Example

Request Body^required