COYO provides some managing endpoints to help you perform some operations and maintenance tasks.
All endpoints are protected with the basic auth credentials of the corresponding platform. The credentials can be found under COYO_MANAGEMENT_USER
andCOYO_MANAGEMENT_PASSWORD
in your .env file.
Use the following syntax to access these endpoints:
curl -u "$COYO_MANAGEMENT_USER>:$COYO_MANAGEMENT_PASSWORD" -X "POST" $COYO_BACKEND_URL/ENDPOINT
Use the following syntax to access these endpoints if a request body is required:
curl -u "$COYO_MANAGEMENT_USER>:$COYO_MANAGEMENT_PASSWORD" -X POST $COYO_BACKEND_URL/ENDPOINT \ -H 'content-type: application/json' \ -d '{"BODY_KEY1": "BODY_VALUE1"}'
For example if you want to refresh the index "search:file":
curl -u "admin:admin" -X POST http://local.coyo4.com/manage/index/refresh \ -H 'content-type: application/json' \ -d '{"indexNames" : [ "search:file" ], "update" : true, "delete" : true}'
Here you can find a list of all available index that can be refreshed/recreated:
COYO Version 21
search:file
workspace
search:blog-article
search:task
search:wiki-articles
subscription
search:user
forum-thread
search:workspace
search:app
search:comment
list-entry
message-channel
event
timeline-item
form-entry
event-membership
search:timeline-item
search:list-entry
search:message
forum-thread-answer
message
search:page
sender
search:event
search:forum-thread
page
search:landing-page
user
COYO Version 25
search:file
workspace
search:blog-article
search:task
search:wiki-articles
subscription
search:user
forum-thread
search:workspace
search:app
search:comment
list-entry
message-channel
choosable
event
timeline-item
form-entry
event-membership
search:timeline-item
search:list-entry
search:message
forum-thread-answer
message
search:page
sender
search:event
search:forum-thread
page
search:landing-page
user
COYO Version 28
search:file
workspace
search:blog-article
search:task
search:wiki-article
subscription
search:user
search:workspace
search:app
search:comment
list-entry
message-channel
choosable
event
timeline-item
form-entry
event-membership
search:timeline-item
search:list-entry
search:message
forum-thread-answer
message
search:page
sender
search:event
search:forum-thread
page
search:landing-page
user
COYO Version 30
search:file
workspace
search:blog-article
search:task
search:wiki-article
search:user
forum-thread
search:workspace
search:app
search:comment
list-entry
message-channel
choosable
event
timeline-item
form-entry
event-membership
search:timeline-item
search:list-entry
search:message
forum-thread-answer
message
search:page
sender
search:event
search:forum-thread
page
search:landing-page
user
COYO Version 31
search:event
search:timeline-item
search:landing-page
search:page
search:workspace
search:user
search:app
search:file
search:blog-article
search:wiki-article
search:task
search:list-entry
search:forum-thread
search:message
search:comment
choosable
sender
event
event-membership
page
workspace
timeline-item
user
list-entry
form-entry
forum-thread-answer
forum-thread
message
message-channel