CatenaApiKeys
catena-tools-core (v1)
On the right hand side of this page, you will see a list of "Servers".
- Mock server: This server will return mock responses to all requests. It is best used when evaluating the shape of the Catena API.
- Localhost: This server will point at a locally running version of Catena. It is best used when you want to make real requests or to validate that Catena is properly running on your machine.
- Custom Domain: This server will point at any domain you specify with the domain variable. It is best used when you have a version of Catena deployed to a live environment and you want to make real requests against it.
To configure which server is shown in example requests:
- Select the "Try it" button on any API operation within the API explorer
- Select your environment
- If you want to point the API explorer to an instance of Catena you have deployed, select "Custom Domain" and configure the
domainenvironment variable.
- You're all set! This setting will be cached across all API operations exposed in these docs.
Download OpenAPI description
Languages
Servers
Mock server
https://docs.catenatools.com/_mock/apis/catena-tools-core/
Localhost
http://localhost:5000/
Custom Domain
https://{domain}/
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/sessions
- Localhost http://localhost:5000/api/v1/sessions
- Custom Domain https://your_domain_here/api/v1/sessions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/sessionsResponse
application/json
{ "sessions": { "property1": { … }, "property2": { … } } }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/sessions/healthz
- Localhost http://localhost:5000/api/v1/sessions/healthz
- Custom Domain https://your_domain_here/api/v1/sessions/healthz
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/sessions/healthzResponse
application/json
{ "healthy": true, "components": [ { … } ] }