Platform Index

Introduction

The Platform Index API holds information about production servers...

Use it for looking up things that you need to find. Or fill it with data that you want to be able to find again.

Services and Queues are monitored through this API at the NOC

Scripts to run at the server to make it available in this API are at : http://gitlab.clubmessage.local/devops/platformindex-scripts

/databases

Collection of data about known databasescode text here

GET /

get a list of all databases

POST /server/{servername}

save a list of databases for the specified server

GET /server/{servername}

get a ist of databases on the specified serer

GET /server/{servername}/database/{databasename}

get a list of database items in the databases with names that hit *{databasename}* on the specified server

GET /server/{servername}/database/{databasename}/item/{itemname}

get a list of database items in the databases with names that hit *{databasename}* and itemnames hit *{itemname}* on the specified server

GET /search/{query}

returns all databases that hit on *{query}*

GET /queues/{database}/{queue}

lists all database items for all databases that hit *{database}* and items that hit *{queue}*queue*

This way you can easily monitor all smsc mt queues for instance, calling /queues/smsc/mt

/files

The files resource receives and returns all file related information

GET /search

Search for files, folders and shares hitting your query.

Your query will be matched *{search}* on any file, folder, share or drive.

You can narrow your search by providing a {filter} as second argument. These are for all files :

  • file
  • folder
  • share
  • drive

When there are more details provided for a file while it was inserted in the API, you can look for them too. Some examples :

  • account
  • connectionstring
  • servicename

/servers

GET /ping

The Ping resource is a very simple way to have some kind of heartbeat

Your server just sends a GET request to this resource with it's name to keep the server updated in the API

/services

The Service resource receives and returns all service related information