v1

latestSwagger 2.02026-07-172964242.9 KB

Host

Remove host

Removes a host from the cluster.

delete/v1/hosts/{host_id}

Path parameters

host_idstring required

A user-specified identifier. Must be 1-36 characters, contain only lower-cased letters and hyphens, start and end with a letter or number, and not contain consecutive hyphens.

Query parameters

forceboolean

Force removal even if instances exist or quorum would be violated. Use only for disaster recovery when a host is permanently lost.

Response

OK response.

Example response

{
  "task": {
    "completed_at": "2025-06-18T16:52:35Z",
    "created_at": "2025-06-18T16:52:05Z",
    "database_id": "storefront",
    "entity_id": "storefront",
    "scope": "database",
    "status": "completed",
    "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
    "type": "create"
  },
  "update_database_tasks": [
    {
      "completed_at": "2025-06-18T16:52:35Z",
      "created_at": "2025-06-18T16:52:05Z",
      "database_id": "storefront",
      "entity_id": "storefront",
      "scope": "database",
      "status": "completed",
      "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
      "type": "create"
    },
    {
      "completed_at": "2025-06-18T16:52:35Z",
      "created_at": "2025-06-18T16:52:05Z",
      "database_id": "storefront",
      "entity_id": "storefront",
      "scope": "database",
      "status": "completed",
      "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
      "type": "create"
    },
    {
      "completed_at": "2025-06-18T16:52:35Z",
      "created_at": "2025-06-18T16:52:05Z",
      "database_id": "storefront",
      "entity_id": "storefront",
      "scope": "database",
      "status": "completed",
      "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
      "type": "create"
    }
  ]
}