Cockpit CMS

Documentation for the Cockpit API can be found here: https://getcockpit.com/documentation/api/collections

We provide a read/write transparent proxy at /cms/cockpit that requires full authentication and a public read only proxy at /cms. The translation table below maps each endpoint to the proxied equivalent. Of course when reading the Cockpit documentation you can skip the authentication/authorization part, Satellite Tag will handle that for you.

Try not to use APIs flagged as not “In use” cause they’ve not been tested.

Cockpit	In use	Read-only (public access)	Read/Write (OAuth2 auth)
/api/collections/listCollections	Yes	/cms/collections/listCollections	/cms/cockpit/collections/listCollections
/api/collections/collection/{collectionname}	Yes	/cms/collections/collection/{collectionname}	/cms/cockpit/collections/collection/{collectionname}
/api/collections/get/{collectionname}	Yes	/cms/collections/get/{collectionname}	/cms/cockpit/collections/get/{collectionname}
/api/collections/save/{collectionname}	Yes		/cms/cockpit/collections/save/{collectionname}
/api/collections/remove/{collectionname}	No		/cms/cockpit/collections/remove/{collectionname}
/api/regions/listRegions	Yes	/cms/regions/listRegions	/cms/cockpit/regions/listRegions
/api/regions/get/{regionname}	Yes	/cms/regions/get/{regionname}	/cms/cockpit/regions/get/{regionname}
/api/regions/data/{regionname}	No	/cms/regions/data/{regionname}	/cms/cockpit/regions/data/{regionname}

Note

All Satellite Tag endpoints must be prefixed according to the domain name and API prefix for the instance you are interacting with.

Note

API request and response data formats are different for these endpoint. What Satellite Tag provides is just a transparent proxy between you and Cockpit, data passing through this proxy is left as is so you cannot expect the following to be consistent with all other Satellite Tag APIs:

• JSON response structure
• JSON request structure
• response headers
• error handling