HydraCore
API by router

Website pages

List Pages

GET
/v1/website/{config_id}/pages

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

config_id*Config Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/v1/website/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages'
Example Response
[  {    "content_html": "string",    "created_at": "2019-08-24T14:15:22Z",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "metadata_json": {},    "slug": "string",    "sort_order": 0,    "status": "draft",    "title": "string",    "updated_at": "2019-08-24T14:15:22Z",    "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"  }]

Create Page

POST
/v1/website/{config_id}/pages

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

config_id*Config Id
Formatuuid

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
content_html?Content Html
Default""
metadata_json?
Default{}
slug*Slug
Match^[a-z0-9][a-z0-9\-]*$
Lengthlength <= 200
sort_order?Sort Order
Default0
status?Status
Match^(draft|published|archived)$
Default"draft"
title*Title
Lengthlength <= 300

Response Body

Successful Response

application/json
  1. response
content_html*Content Html
created_at*Created At
Formatdate-time
id*Id
Formatuuid
metadata_json?
Default{}
slug*Slug
sort_order?Sort Order
Default0
status?Status
Default"draft"
title*Title
updated_at*Updated At
Formatdate-time
website_config_id*Website Config Id
Formatuuid
Example Request
curl -X POST 'https://example.com/v1/website/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages' \  -H 'Content-Type: application/json' \  -d '{  "slug": "string",  "title": "string"}'
Example Response
{  "content_html": "string",  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "metadata_json": {},  "slug": "string",  "sort_order": 0,  "status": "draft",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"}

Get Page

GET
/v1/website/{config_id}/pages/{slug}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

config_id*Config Id
Formatuuid
slug*Slug

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

application/json
  1. response
content_html*Content Html
created_at*Created At
Formatdate-time
id*Id
Formatuuid
metadata_json?
Default{}
slug*Slug
sort_order?Sort Order
Default0
status?Status
Default"draft"
title*Title
updated_at*Updated At
Formatdate-time
website_config_id*Website Config Id
Formatuuid
Example Request
curl -X GET 'https://example.com/v1/website/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages/string'
Example Response
{  "content_html": "string",  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "metadata_json": {},  "slug": "string",  "sort_order": 0,  "status": "draft",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"}

Delete Page

DELETE
/v1/website/{config_id}/pages/{slug}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

config_id*Config Id
Formatuuid
slug*Slug

Header Parameters

X-Api-Key?string|null

Response Body

Successful Response

Example Request
curl -X DELETE 'https://example.com/v1/website/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages/string'
Example Response
Empty

Update Page

PUT
/v1/website/{config_id}/pages/{slug}

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

config_id*Config Id
Formatuuid
slug*Slug

Header Parameters

X-Api-Key?string|null

Request Body

application/json
  1. body
content_html?string|null
metadata_json?|null
sort_order?integer|null
status?|null
title?|null

Response Body

Successful Response

application/json
  1. response
content_html*Content Html
created_at*Created At
Formatdate-time
id*Id
Formatuuid
metadata_json?
Default{}
slug*Slug
sort_order?Sort Order
Default0
status?Status
Default"draft"
title*Title
updated_at*Updated At
Formatdate-time
website_config_id*Website Config Id
Formatuuid
Example Request
curl -X PUT 'https://example.com/v1/website/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "content_html": "string",  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "metadata_json": {},  "slug": "string",  "sort_order": 0,  "status": "draft",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "website_config_id": "c0aa0662-77a9-4227-8f52-c7a29b8a3ad3"}

Website media

Previous Page

Websites

Next Page