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/fleets/deploy
- Localhost http://localhost:5000/api/v1/fleets/deploy
- Custom Domain https://your_domain_here/api/v1/fleets/deploy
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/fleets/deploy \
-H 'Content-Type: application/json' \
-d '{
"config": {
"name": "string",
"artifacts": [
{
"name": "string",
"remote": "string",
"integrity": {
"alg": "string",
"hash": "string"
},
"config": "string"
}
],
"job": {
"requirements": {
"property1": "string",
"property2": "string"
},
"exec": [
{
"cmd": "string",
"args": [
"string"
],
"environment": [
"string"
]
}
],
"include": [
{
"name": "string",
"dest": "string",
"executable": true
}
],
"restartPolicy": "string"
}
}
}'Response
application/json
{ "hostId": "string", "responses": [ "string" ] }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/fleets/hosts
- Localhost http://localhost:5000/api/v1/fleets/hosts
- Custom Domain https://your_domain_here/api/v1/fleets/hosts
- 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/fleets/hostsResponse
application/json
{ "hosts": [ { … } ] }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/fleets/hosts/{hostId}/action
- Localhost http://localhost:5000/api/v1/fleets/hosts/{hostId}/action
- Custom Domain https://your_domain_here/api/v1/fleets/hosts/{hostId}/action
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/fleets/hosts/{hostId}/action' \
-H 'Content-Type: application/json' \
-d '{
"hostId": "string",
"request": {
"targetPx": "string",
"stateAfterAction": "string",
"req": {
"method": "string",
"body": "string",
"path": "string",
"port": 0,
"headers": {
"property1": "string",
"property2": "string"
}
}
}
}'Response
application/json
{}