Aiven · Example Payload

Aiven List Services

Example request to retrieve all managed services within a project

Managed Data InfrastructureApache KafkaPostgreSQLOpenSearchClickHouseRedisMySQLOpen SourceCloud DatabaseDBaaSData StreamingData Platform

Aiven List Services is an example object payload from Aiven, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

{
  "summary": "List all services in a project",
  "description": "Example request to retrieve all managed services within a project",
  "request": {
    "method": "GET",
    "url": "https://api.aiven.io/v1/project/{project}/service",
    "headers": {
      "Authorization": "Bearer {token}"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "services": [
        {
          "service_name": "my-kafka-cluster",
          "service_type": "kafka",
          "state": "RUNNING",
          "plan": "business-4",
          "cloud_name": "aws-us-east-1"
        },
        {
          "service_name": "my-postgres-db",
          "service_type": "pg",
          "state": "RUNNING",
          "plan": "startup-4",
          "cloud_name": "google-europe-west1"
        }
      ]
    }
  }
}