PUT
/
api
/
v1
/
services
/
{id}
Update a service
curl --request PUT \
  --url https://app.miget.com/api/v1/services/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "ram_size": 123,
  "disk_size": 123,
  "cpu_size": 123,
  "scheduled_backup": "<string>"
}
'
{
  "uuid": "<string>",
  "name": "<string>",
  "label": "<string>",
  "service_type": "<string>",
  "project_id": "<string>",
  "resource_id": "<string>",
  "miget_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connection_details": {
    "internal": {
      "hostname": "my-service-xxx.internal",
      "database": "db_name",
      "port": 5432,
      "username": "db_user",
      "password": "db_password",
      "connection_url": "postgres://db_user:db_password@my-service-xxx.internal:5432/db_name"
    },
    "external": {
      "external_connection_url": "postgres://db_user:db_password@my-service-xxx.external:5432/db_name",
      "psql_command": "PGPASSWORD=db_password psql -h my-service-xxx.external -U db_user db_name"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

​
X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Path Parameters

​
id
string
required

Service ID

Body

application/json

Update a service

​
label
string

Human-readable display name for the service

​
ram_size
number<float>

RAM allocation in MiB (e.g., 64, 128, 256)

​
disk_size
number<float>

Disk storage in GiB (e.g., 1, 5, 10)

​
cpu_size
number<float>

CPU allocation in cores (e.g., 0.1, 0.25, 0.5)

​
public_access
enum<string>

Enable public internet access: '0' disabled, '1' enabled. For postgres type.

Available options:
0,
1
​
backup_enabled
enum<string>

Enable automatic backups: '0' disabled, '1' enabled. For postgres type.

Available options:
0,
1
​
scheduled_backup
string

Cron expression for backup schedule (6-field: second minute hour day month weekday). For postgres type.

​
instances
enum<integer>

Number of database instances (1 for standalone, 3/5/7 for HA cluster). For postgres type.

Available options:
1,
3,
5,
7

Response

Update a service

Api_V1_Entities_Service model

​
uuid
string
required

Service UUID

​
name
string
required

Service name

​
label
string
required

Display name

​
service_type
string
required

Service type (postgres, shared_storage)

​
project_id
string
required

Associated project UUID

​
resource_id
string
required

Assigned resource UUID

​
miget_id
string
required

DEPRECATED: use resource_id instead

​
created_at
string<date-time>
required

Creation timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
connection_details
object
required

Connection details for the service

Example:
{
  "internal": {
    "hostname": "my-service-xxx.internal",
    "database": "db_name",
    "port": 5432,
    "username": "db_user",
    "password": "db_password",
    "connection_url": "postgres://db_user:db_password@my-service-xxx.internal:5432/db_name"
  },
  "external": {
    "external_connection_url": "postgres://db_user:db_password@my-service-xxx.external:5432/db_name",
    "psql_command": "PGPASSWORD=db_password psql -h my-service-xxx.external -U db_user db_name"
  }
}