GET
/
api
/
v1
/
services
List all services
curl --request GET \
  --url https://app.miget.com/api/v1/services \
  --header 'Authorization: <api-key>'
[
  {
    "uuid": "<string>",
    "name": "<string>",
    "label": "<string>",
    "service_type": "<string>",
    "project_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)

Response

List all services

​
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

​
miget_id
string
required

Assigned resource UUID

​
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"
  }
}