HydraCore
API by router

Shared hosting

Get Customer Config Overlay

GET
/v1/shared-hosting/customers/{customer_id}/config

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Query Parameters

instance_idInstance Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/shared-hosting/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/config?instance_id=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
{
  "config_overlay": {},
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Remove Customer

DELETE
/v1/shared-hosting/customers/{customer_id}/instances/{instance_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid
instance_idInstance Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

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

Update Customer Config Overlay

PUT
/v1/shared-hosting/customers/{customer_id}/instances/{instance_id}/config

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid
instance_idInstance Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

config_overlayConfig Overlay

Empty Object

Response Body

curl -X PUT "https://loading/v1/shared-hosting/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/config" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "config_overlay": {}  }'
{
  "config_overlay": {},
  "created_at": "2019-08-24T14:15:22Z",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Agent Host Nodes

GET
/v1/shared-hosting/nodes

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/shared-hosting/nodes" \  -H "X-Api-Key: string"
[
  {
    "capacity": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "current_load": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
    "status": "string",
    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Agent Host Node

POST
/v1/shared-hosting/nodes

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

capacity?Capacity
Default50
Range1 <= value <= 500
instance_idInstance Id
Formatuuid

Response Body

curl -X POST "https://loading/v1/shared-hosting/nodes" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366"  }'
{
  "capacity": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "current_load": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Agent Host Node

PATCH
/v1/shared-hosting/nodes/{node_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

node_idNode Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

capacity?Capacity
status?Status

Response Body

curl -X PATCH "https://loading/v1/shared-hosting/nodes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "capacity": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "current_load": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Node Customers

List all customers placed on a shared node.

GET
/v1/shared-hosting/nodes/{node_id}/customers

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/shared-hosting/nodes/497f6eca-6276-4993-bfeb-53cbbbba6f08/customers" \  -H "X-Api-Key: string"
[
  {
    "customer_email": "string",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "customer_name": "string",
    "placed_at": "2019-08-24T14:15:22Z",
    "status": "active"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Place Customer

POST
/v1/shared-hosting/place

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

config_overlay?Config Overlay

Empty Object

customer_idCustomer Id
Formatuuid
node_id?Node Id

Response Body

curl -X POST "https://loading/v1/shared-hosting/place" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"  }'
{
  "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "node_id": "6e0bdcac-9717-4a6f-972e-97489dffeb0c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Settings

Previous Page

Shared hosting internal

Next Page