From 7887f0ab9d887b16b9153c791a7858161aa69930 Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Mon, 12 Jan 2026 10:04:39 +0100 Subject: [PATCH 1/7] add db endpoints --- _scalingo_api/databases_ng.md | 169 ++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 _scalingo_api/databases_ng.md diff --git a/_scalingo_api/databases_ng.md b/_scalingo_api/databases_ng.md new file mode 100644 index 0000000..5522c1e --- /dev/null +++ b/_scalingo_api/databases_ng.md @@ -0,0 +1,169 @@ +--- +title: Databases NG +layout: default +--- + +# Databases NG + +--- row --- + +**Database attributes** + +{:.table} +| field | type | description | +| ----------- | ------ | ----------------------------------------------------- | +| id | string | unique ID | +| name | string | name of the database | +| project_id | string | ID of the project the database belongs to | +| technology | string | database technology (e.g., postgresql, mysql, mongodb)| +| plan | string | plan name (e.g., postgresql-starter-512, mysql-business-1024) | + +||| col ||| + +Example object: + +```json +{ + "id": "54100930736f7563d5030000", + "name": "my-postgres-db", + "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", + "technology": "postgresql", + "plan": "postgresql-starter-512" +} +``` + +--- row --- + +## Create a Database + +--- row --- + +`POST https://$SCALINGO_API_URL/v1/databases` + +### Parameters + +* `database.name`: Database name. Should have between 6 and 48 lower case alphanumerical characters + and hyphens, it can't have an hyphen at the beginning or at the end, nor two + hyphens in a row. +* `database.technology`: Database technology identifier (e.g., `postgresql`, `mysql`, `mongodb`, `redis`, `elasticsearch`, `influxdb`) +* `database.plan_id`: Plan identifier (e.g., `postgresql-starter-512`, `mysql-business-1024`) +* `database.project_id`: (*Optional*) ID of the project to assign the database to. If not provided, the database will be assigned to your default project. + +||| col ||| + +Example + +```sh +curl -H "Accept: application/json" -H "Content-Type: application/json" \ + -H "Authorization: Bearer $BEARER_TOKEN" \ + -X POST https://$SCALINGO_API_URL/v1/databases -d \ + '{ + "database": { + "name": "my-postgres-db", + "technology": "postgresql", + "plan": "postgresql-starter-512", + "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f" + } + }' +``` + +Returns 201 Created + +```json +{ + "database": { + "id": "54100930736f7563d5030000", + "name": "my-postgres-db", + "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", + "technology": "postgresql", + "plan": "postgresql-starter-512" + } +} +``` + +--- row --- + +## List Your Databases + +--- row --- + +`GET https://$SCALINGO_API_URL/v1/databases` + +List all your databases. + +||| col ||| + +Example + +```shell +curl -H "Accept: application/json" -H "Content-Type: application/json" \ + -H "Authorization: Bearer $BEARER_TOKEN" \ + -X GET https://$SCALINGO_API_URL/v1/databases +``` + +Returns 200 OK + +```json +{ + "databases": [ + { + "id": "54100930736f7563d5030000", + "name": "my-postgres-db", + "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", + "technology": "postgresql", + "plan": "postgresql-starter-512" + }, + { + "id": "54100930736f7563d5030001", + "name": "my-redis-db", + "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", + "technology": "redis", + "plan": "redis-starter-256" + } + ] +} +``` + +--- row --- + +## Get a Precise Database + +--- row --- + +`GET https://$SCALINGO_API_URL/v1/databases/[:database]` + +Display a precise database. + +||| col ||| + +Example request + +```shell +curl -H "Accept: application/json" -H "Content-Type: application/json" \ + -H "Authorization: Bearer $BEARER_TOKEN" \ + -X GET https://$SCALINGO_API_URL/v1/databases/my-postgres-db +``` + +Returns 200 OK + +```json +{ + "database": { + "id": "54100930736f7563d5030000", + "name": "my-postgres-db", + "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", + "technology": "postgresql", + "plan": "postgresql-starter-512" + } +} +``` + +Returns 404 Not Found if the database doesn't exist + +```json +{ + "error": "Database not found" +} +``` + +--- row --- From c8037ecc30cc566fe378d5ea0061c1023bd06023 Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Mon, 12 Jan 2026 10:13:03 +0100 Subject: [PATCH 2/7] rename url --- _scalingo_api/{databases_ng.md => dedicated_databases.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename _scalingo_api/{databases_ng.md => dedicated_databases.md} (99%) diff --git a/_scalingo_api/databases_ng.md b/_scalingo_api/dedicated_databases.md similarity index 99% rename from _scalingo_api/databases_ng.md rename to _scalingo_api/dedicated_databases.md index 5522c1e..1938dab 100644 --- a/_scalingo_api/databases_ng.md +++ b/_scalingo_api/dedicated_databases.md @@ -1,5 +1,5 @@ --- -title: Databases NG +title: Databases layout: default --- From d7c6882888f52c0d6da9746eedfc1978850525b8 Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Mon, 12 Jan 2026 10:14:42 +0100 Subject: [PATCH 3/7] remove ng --- _scalingo_api/dedicated_databases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_scalingo_api/dedicated_databases.md b/_scalingo_api/dedicated_databases.md index 1938dab..ced145d 100644 --- a/_scalingo_api/dedicated_databases.md +++ b/_scalingo_api/dedicated_databases.md @@ -3,7 +3,7 @@ title: Databases layout: default --- -# Databases NG +# Databases --- row --- From 0afba0c3aa7d63b00707690d4d4566df284d02ae Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Mon, 12 Jan 2026 10:56:59 +0100 Subject: [PATCH 4/7] use dr --- _scalingo_api/{dedicated_databases.md => databases_dr.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename _scalingo_api/{dedicated_databases.md => databases_dr.md} (100%) diff --git a/_scalingo_api/dedicated_databases.md b/_scalingo_api/databases_dr.md similarity index 100% rename from _scalingo_api/dedicated_databases.md rename to _scalingo_api/databases_dr.md From caa5de33599a611f201c2c434eff2d8a870c48de Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Mon, 12 Jan 2026 18:22:38 +0100 Subject: [PATCH 5/7] add comments + use correct plan --- _scalingo_api/databases_dr.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/_scalingo_api/databases_dr.md b/_scalingo_api/databases_dr.md index ced145d..3c5807d 100644 --- a/_scalingo_api/databases_dr.md +++ b/_scalingo_api/databases_dr.md @@ -27,8 +27,8 @@ Example object: "id": "54100930736f7563d5030000", "name": "my-postgres-db", "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", - "technology": "postgresql", - "plan": "postgresql-starter-512" + "technology": "postgresql-ng", + "plan": "postgresql-ng-starter-4096" } ``` @@ -45,8 +45,8 @@ Example object: * `database.name`: Database name. Should have between 6 and 48 lower case alphanumerical characters and hyphens, it can't have an hyphen at the beginning or at the end, nor two hyphens in a row. -* `database.technology`: Database technology identifier (e.g., `postgresql`, `mysql`, `mongodb`, `redis`, `elasticsearch`, `influxdb`) -* `database.plan_id`: Plan identifier (e.g., `postgresql-starter-512`, `mysql-business-1024`) +* `database.technology`: Database technology identifier (only `postgresql-ng` is supported for now) +* `database.plan`: Plan identifier (e.g., `postgresql-ng-starter-4096`). Available plans can be retrieved via the [Addon Providers endpoint](/addon_providers). * `database.project_id`: (*Optional*) ID of the project to assign the database to. If not provided, the database will be assigned to your default project. ||| col ||| @@ -60,8 +60,8 @@ curl -H "Accept: application/json" -H "Content-Type: application/json" \ '{ "database": { "name": "my-postgres-db", - "technology": "postgresql", - "plan": "postgresql-starter-512", + "technology": "postgresql-ng", + "plan": "postgresql-ng-starter-4096", "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f" } }' @@ -75,8 +75,8 @@ Returns 201 Created "id": "54100930736f7563d5030000", "name": "my-postgres-db", "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", - "technology": "postgresql", - "plan": "postgresql-starter-512" + "technology": "postgresql-ng", + "plan": "postgresql-ng-starter-4096" } } ``` @@ -110,8 +110,8 @@ Returns 200 OK "id": "54100930736f7563d5030000", "name": "my-postgres-db", "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", - "technology": "postgresql", - "plan": "postgresql-starter-512" + "technology": "postgresql-ng", + "plan": "postgresql-ng-starter-4096" }, { "id": "54100930736f7563d5030001", @@ -152,8 +152,8 @@ Returns 200 OK "id": "54100930736f7563d5030000", "name": "my-postgres-db", "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", - "technology": "postgresql", - "plan": "postgresql-starter-512" + "technology": "postgresql-ng", + "plan": "postgresql-ng-starter-4096" } } ``` From 56b62ea72628e0dac35dfb1a7142560a2f8a7f52 Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Tue, 13 Jan 2026 08:54:31 +0100 Subject: [PATCH 6/7] add note for other technos --- _scalingo_api/databases_dr.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_scalingo_api/databases_dr.md b/_scalingo_api/databases_dr.md index 3c5807d..b121413 100644 --- a/_scalingo_api/databases_dr.md +++ b/_scalingo_api/databases_dr.md @@ -42,13 +42,13 @@ Example object: ### Parameters -* `database.name`: Database name. Should have between 6 and 48 lower case alphanumerical characters - and hyphens, it can't have an hyphen at the beginning or at the end, nor two - hyphens in a row. -* `database.technology`: Database technology identifier (only `postgresql-ng` is supported for now) +* `database.name`: Database name. Should have between 6 and 48 lower case alphanumerical characters and hyphens. +* `database.technology`: Database technology identifier. Only `postgresql-ng` is supported for now. * `database.plan`: Plan identifier (e.g., `postgresql-ng-starter-4096`). Available plans can be retrieved via the [Addon Providers endpoint](/addon_providers). * `database.project_id`: (*Optional*) ID of the project to assign the database to. If not provided, the database will be assigned to your default project. +**Note:** To provision other database types (MySQL, MongoDB, Redis, etc.), please use the [Addons provisioning endpoint](/addons#provision-an-addon). + ||| col ||| Example From 2698a2006c4f0e005e33a52eb9b5c15a8b2748cc Mon Sep 17 00:00:00 2001 From: Annabelle PELLIER Date: Tue, 13 Jan 2026 09:14:15 +0100 Subject: [PATCH 7/7] remove non ng examples --- _scalingo_api/databases_dr.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_scalingo_api/databases_dr.md b/_scalingo_api/databases_dr.md index b121413..5b733f4 100644 --- a/_scalingo_api/databases_dr.md +++ b/_scalingo_api/databases_dr.md @@ -15,8 +15,8 @@ layout: default | id | string | unique ID | | name | string | name of the database | | project_id | string | ID of the project the database belongs to | -| technology | string | database technology (e.g., postgresql, mysql, mongodb)| -| plan | string | plan name (e.g., postgresql-starter-512, mysql-business-1024) | +| technology | string | database technology (e.g., postgresql-ng)| +| plan | string | plan name (e.g., postgresql-ng-starter-4096) | ||| col ||| @@ -115,10 +115,10 @@ Returns 200 OK }, { "id": "54100930736f7563d5030001", - "name": "my-redis-db", + "name": "backup-db", "project_id": "pr-82a3cac5-9b25-473e-b33d-6272b87e636f", - "technology": "redis", - "plan": "redis-starter-256" + "technology": "postgresql-ng", + "plan": "postgresql-ng-starter-4096" } ] }