HydraCore
API by router

Webhost

List Webhost Nodes

GET
/v1/webhost/nodes

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/nodes" \  -H "X-Api-Key: string"
[
  {
    "capacity_sites": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "host_instance_id": "e4401c96-13ab-4e07-90ac-7be0c56a09cc",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadata_json": {},
    "name": "string",
    "region_id": "string",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "used_sites": 0
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Webhost Node

POST
/v1/webhost/nodes

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

capacity_sites?Capacity Sites
Default25
Range1 <= value <= 500
host_instance_idHost Instance Id
Formatuuid
nameName
Length1 <= length <= 120

Response Body

curl -X POST "https://loading/v1/webhost/nodes" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "host_instance_id": "e4401c96-13ab-4e07-90ac-7be0c56a09cc",    "name": "string"  }'
{
  "capacity_sites": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "host_instance_id": "e4401c96-13ab-4e07-90ac-7be0c56a09cc",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "region_id": "string",
  "status": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "used_sites": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Webhost Node

GET
/v1/webhost/nodes/{node_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

node_idNode Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/nodes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
{
  "capacity_sites": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "host_instance_id": "e4401c96-13ab-4e07-90ac-7be0c56a09cc",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "region_id": "string",
  "status": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "used_sites": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Webhost Capacity

GET
/v1/webhost/nodes/{node_id}/capacity

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

node_idNode Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/nodes/497f6eca-6276-4993-bfeb-53cbbbba6f08/capacity" \  -H "X-Api-Key: string"
{
  "available_sites": 0,
  "capacity_sites": 0,
  "node_id": "6e0bdcac-9717-4a6f-972e-97489dffeb0c",
  "status": "string",
  "used_sites": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Webhost Node Telemetry

GET
/v1/webhost/nodes/{node_id}/telemetry

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

node_idNode Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/nodes/497f6eca-6276-4993-bfeb-53cbbbba6f08/telemetry" \  -H "X-Api-Key: string"
{
  "app_sites": 0,
  "collected_at": "2019-08-24T14:15:22Z",
  "disk_available_bytes": 0,
  "disk_total_bytes": 0,
  "disk_used_bytes": 0,
  "error": "string",
  "host_instance_id": "e4401c96-13ab-4e07-90ac-7be0c56a09cc",
  "host_instance_status": "string",
  "keep_bytes_budget": 0,
  "keep_count": 0,
  "live_sites": 0,
  "node_id": "6e0bdcac-9717-4a6f-972e-97489dffeb0c",
  "reachable": true,
  "release_bytes": 0,
  "release_count": 0,
  "total_sites": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Hosted Websites

GET
/v1/webhost/sites

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/sites" \  -H "X-Api-Key: string"
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "current_commit_sha": "string",
    "current_release_id": "string",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "dedicated_instance_id": "e82b7abe-feea-468c-83e4-862e76c31e5f",
    "deployed_at": "2019-08-24T14:15:22Z",
    "hosting_mode": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadata_json": {},
    "name": "string",
    "primary_domain": "string",
    "repo_path": "string",
    "status": "string",
    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    "updated_at": "2019-08-24T14:15:22Z",
    "webhost_node_id": "74e0578b-8bae-4d5e-9ee2-da58f6bde41d",
    "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Hosted Website

POST
/v1/webhost/sites

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

customer_id?Customer Id
dedicated_instance_id?Dedicated Instance Id
hosting_modeHosting Mode
Match^(dedicated|shared)$
nameName
Length1 <= length <= 160
primary_domain?Primary Domain
webhost_node_id?Webhost Node Id
website_config_id?Website Config Id

Response Body

curl -X POST "https://loading/v1/webhost/sites" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "hosting_mode": "string",    "name": "string"  }'
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_commit_sha": "string",
  "current_release_id": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "dedicated_instance_id": "e82b7abe-feea-468c-83e4-862e76c31e5f",
  "deployed_at": "2019-08-24T14:15:22Z",
  "hosting_mode": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "primary_domain": "string",
  "repo_path": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z",
  "webhost_node_id": "74e0578b-8bae-4d5e-9ee2-da58f6bde41d",
  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Hosted Website

GET
/v1/webhost/sites/{website_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_commit_sha": "string",
  "current_release_id": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "dedicated_instance_id": "e82b7abe-feea-468c-83e4-862e76c31e5f",
  "deployed_at": "2019-08-24T14:15:22Z",
  "hosting_mode": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "primary_domain": "string",
  "repo_path": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z",
  "webhost_node_id": "74e0578b-8bae-4d5e-9ee2-da58f6bde41d",
  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Hosted Website

PATCH
/v1/webhost/sites/{website_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

dedicated_instance_id?Dedicated Instance Id
name?Name
primary_domain?Primary Domain
status?Status
webhost_node_id?Webhost Node Id

Response Body

curl -X PATCH "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_commit_sha": "string",
  "current_release_id": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "dedicated_instance_id": "e82b7abe-feea-468c-83e4-862e76c31e5f",
  "deployed_at": "2019-08-24T14:15:22Z",
  "hosting_mode": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "primary_domain": "string",
  "repo_path": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z",
  "webhost_node_id": "74e0578b-8bae-4d5e-9ee2-da58f6bde41d",
  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Hosted Website

DELETE
/v1/webhost/sites/{website_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X DELETE "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Website Analytics

Get analytics summary for a hosted website.

GET
/v1/webhost/sites/{website_id}/analytics

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Query Parameters

period?Period
Default7

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/analytics?period=7" \  -H "X-Api-Key: string"
{
  "daily_views": [
    {}
  ],
  "device_breakdown": {},
  "period_days": 0,
  "top_pages": [
    {}
  ],
  "total_views": 0,
  "unique_sessions": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Deploy Hosted Website

POST
/v1/webhost/sites/{website_id}/deploy

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X POST "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/deploy" \  -H "X-Api-Key: string"
{
  "message": "string",
  "status": "string",
  "task_id": "string",
  "website_id": "9a5872c2-0bf0-4c68-9c27-86a09b05bf66"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Form Submissions

List form submissions for a hosted website.

GET
/v1/webhost/sites/{website_id}/forms

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Query Parameters

unread_only?Unread Only
Defaultfalse

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms?unread_only=false" \  -H "X-Api-Key: string"
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "form_data": {},
    "hosted_website_id": "2e68090f-4b97-4f89-8ca4-5adeb58dde95",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_read": true,
    "page_slug": "string",
    "submitter_email": "string",
    "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Form Submission Stats

Get submission count and unread count for a hosted website.

GET
/v1/webhost/sites/{website_id}/forms/stats

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms/stats" \  -H "X-Api-Key: string"
{
  "total": 0,
  "unread": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Mark Form Submission Read

Mark a form submission as read.

PATCH
/v1/webhost/sites/{website_id}/forms/{submission_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid
submission_idSubmission Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X PATCH "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
{
  "created_at": "2019-08-24T14:15:22Z",
  "form_data": {},
  "hosted_website_id": "2e68090f-4b97-4f89-8ca4-5adeb58dde95",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "is_read": true,
  "page_slug": "string",
  "submitter_email": "string",
  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Hosted Website History

GET
/v1/webhost/sites/{website_id}/history

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/history" \  -H "X-Api-Key: string"
[
  {
    "actor_user_id": "d6ed4497-4325-4995-9f49-e288b7192e46",
    "artifact_hash": "string",
    "change_source": "string",
    "commit_sha": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "deployed_at": "2019-08-24T14:15:22Z",
    "hosted_website_id": "2e68090f-4b97-4f89-8ca4-5adeb58dde95",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadata_json": {},
    "notes": "string",
    "release_id": "string",
    "status": "string"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Live Migrate Hosted Website Endpoint

POST
/v1/webhost/sites/{website_id}/live-migrate

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

target_node_idTarget Node Id
Formatuuid

Response Body

curl -X POST "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/live-migrate" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "target_node_id": "b1754cfa-2739-4a10-a13a-c665edec0e55"  }'
{
  "message": "string",
  "status": "string",
  "task_id": "string",
  "website_id": "9a5872c2-0bf0-4c68-9c27-86a09b05bf66"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Migrate Hosted Website

POST
/v1/webhost/sites/{website_id}/migrate

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

dedicated_instance_id?Dedicated Instance Id
primary_domain?Primary Domain
target_modeTarget Mode
Match^(shared|dedicated)$
webhost_node_id?Webhost Node Id

Response Body

curl -X POST "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/migrate" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "target_mode": "string"  }'
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_commit_sha": "string",
  "current_release_id": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "dedicated_instance_id": "e82b7abe-feea-468c-83e4-862e76c31e5f",
  "deployed_at": "2019-08-24T14:15:22Z",
  "hosting_mode": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "primary_domain": "string",
  "repo_path": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z",
  "webhost_node_id": "74e0578b-8bae-4d5e-9ee2-da58f6bde41d",
  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Rollback Hosted Website

POST
/v1/webhost/sites/{website_id}/rollback

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

website_idWebsite Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

git_ref?Git Ref
release_id?Release Id

Response Body

curl -X POST "https://loading/v1/webhost/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/rollback" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_commit_sha": "string",
  "current_release_id": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "dedicated_instance_id": "e82b7abe-feea-468c-83e4-862e76c31e5f",
  "deployed_at": "2019-08-24T14:15:22Z",
  "hosting_mode": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "metadata_json": {},
  "name": "string",
  "primary_domain": "string",
  "repo_path": "string",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z",
  "webhost_node_id": "74e0578b-8bae-4d5e-9ee2-da58f6bde41d",
  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Voice webhook

Previous Page

Website media

Next Page