Skip to content

Connection check

This method offers a connection check, and if CMS provides a response, it indicates that the connection is correctly established and operational.

URL test:

https://dev.lightcms.io/cms/v1/greeting?name={string}

URL live:

https://fat.lightcms.io/cms/v1/greeting?name={string}

Method:

GET

Path items:

/greeting (Method name)

?name={string} (Value which will be returned by CMS)

Parameters:

Parameter Location Type Example Description Required
?name Path string "World" Value which will be returned by CMS No

Example:

curl -X 'GET' \
  'https://dev.lightcms.io/cms/v1/greeting?name=World' \
  -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK

{
"id": 1,
"content": "Hello, World!",
"version": "@project.version@"
}

Parameter Location Type Example Description
id body number "1" Number of response
content body string "Hello, World!" Response
version body string "@project.version@" Version of project
500 - Internal error

Status Code: 500 Internal error