---
search:
  tags:
    - database-services
    - POST
seo:
  description: >-
    Create a database service. Reference for the POST /api/v1/database-services
    endpoint in the TimescaleDB Enterprise API.
sidebar:
  label: Create a database service
  badge: POST
title: Create a database service
type: openapi-operation
---
`POST /api/v1/database-services`

**Request body** (`application/json`, required)

- `backup_server_id` (string)
- `data_dir` (string)
- `database_name` (string)
- `dcs_cluster_id` (string)
- `extension_versions` (object) — The package version of each extension of extensions with versions, by name: a version of check.extensions of GET /packs/available. An omitted extension gets the newest version in the server packages. TimescaleDB takes timescaledb\_version
- `extensions` (string[])
- `license_file` (string)
- `local_repo_path` (string)
- `name` (string)
- `pack_release` (string) — The release of the server packages to pin, for example v0.11.0-eap.1: a loaded release with the server packages of every PostgreSQL server. Empty pins the newest such release. A restore or a fork takes the pin of the source
- `pg_version` (string)
- `pg_version_minor` (string)
- `pgbackrest_stanza` (string)
- `postgres_password` (string)
- `remote_repo_path` (string)
- `restore_from` (RestoreFromRequest)
- `servers` (DatabaseServiceNodeRequest[])
- `size` (string)
- `timescaledb_version` (string)
- `topology` (string)
- `vip` (string)

Request body example:

```json
{
  "backup_server_id": "string",
  "data_dir": "string",
  "database_name": "string",
  "dcs_cluster_id": "string",
  "extension_versions": {
    "property1": "string",
    "property2": "string"
  },
  "extensions": [
    "string"
  ],
  "license_file": "string",
  "local_repo_path": "string",
  "name": "string",
  "pack_release": "string",
  "pg_version": "string",
  "pg_version_minor": "string",
  "pgbackrest_stanza": "string",
  "postgres_password": "string",
  "remote_repo_path": "string",
  "restore_from": {
    "mode": "string",
    "new_backup_server": "string",
    "new_stanza_name": "string",
    "source_stanza_id": "string"
  },
  "servers": [
    {
      "role": "string",
      "server_id": "string"
    }
  ],
  "size": "string",
  "timescaledb_version": "string",
  "topology": "string",
  "vip": "string"
}
```

**Responses**

- `201` — Created
- `default` — Error

Response example, 201:

```json
{
  "apply_pending": {
    "caps_stale": true,
    "guard_missing": true,
    "licensing_setup": true,
    "restart_marker": true
  },
  "backupConfigOutOfSync": true,
  "backupNeedsAttention": true,
  "backupUnprotected": true,
  "created_at": "string",
  "data_dir": "string",
  "database_name": "string",
  "extension_versions": {
    "property1": "string",
    "property2": "string"
  },
  "extensions": [
    "string"
  ],
  "health": {
    "checked_at": "2019-08-24T14:15:22Z",
    "components": [
      {
        "key": "patroni",
        "message": "string",
        "name": "string",
        "status": "healthy"
      }
    ],
    "reason": "string",
    "since": "2019-08-24T14:15:22Z",
    "status": "healthy"
  },
  "id": "string",
  "license_enforced": true,
  "license_grant_missing": true,
  "livesync_target": true,
  "name": "string",
  "pack_release": "string",
  "pg_version": "string",
  "pg_version_minor": "string",
  "postgresql_exists": true,
  "redeploy_recommended": true,
  "status": "string",
  "timescaledb_version": "string",
  "topology": "single_node",
  "updates_available": true
}
```
