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/api_keys/test
- Localhost http://localhost:5000/api/v1/api_keys/test
- Custom Domain https://your_domain_here/api/v1/api_keys/test
- 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/api_keys/testResponse
application/json
{}
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/permissions
- Localhost http://localhost:5000/api/v1/api_keys/permissions
- Custom Domain https://your_domain_here/api/v1/api_keys/permissions
- 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/api_keys/permissionsResponse
application/json
{ "permissions": [ { … } ] }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/policies
- Localhost http://localhost:5000/api/v1/api_keys/policies
- Custom Domain https://your_domain_here/api/v1/api_keys/policies
- 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/api_keys/policies \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"permissions": [
"string"
]
}'Response
application/json
{ "policy": { "id": "string", "name": "string", "permissions": [ … ] } }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/policies
- Localhost http://localhost:5000/api/v1/api_keys/policies
- Custom Domain https://your_domain_here/api/v1/api_keys/policies
- 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/api_keys/policiesResponse
application/json
{ "policies": [ { … } ] }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/policies/{id}
- Localhost http://localhost:5000/api/v1/api_keys/policies/{id}
- Custom Domain https://your_domain_here/api/v1/api_keys/policies/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/policies/{id}' \
-H 'Content-Type: application/json' \
-d '{
"id": "string",
"name": "string",
"permissions": [
"string"
]
}'Response
application/json
{ "policy": { "id": "string", "name": "string", "permissions": [ … ] } }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/policies/{id}
- Localhost http://localhost:5000/api/v1/api_keys/policies/{id}
- Custom Domain https://your_domain_here/api/v1/api_keys/policies/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/policies/{id}'Response
application/json
{ "policyDeleted": true }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys
- Localhost http://localhost:5000/api/v1/api_keys
- Custom Domain https://your_domain_here/api/v1/api_keys
- 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/api_keys \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"policyId": "string"
}'Response
application/json
{ "apiKey": { "key": "string", "name": "string", "createdOn": "string", "lastUsedOn": "string", "policy": { … } } }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys
- Localhost http://localhost:5000/api/v1/api_keys
- Custom Domain https://your_domain_here/api/v1/api_keys
- 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/api_keysResponse
application/json
{ "apiKeys": [ { … } ] }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/{key}
- Localhost http://localhost:5000/api/v1/api_keys/{key}
- Custom Domain https://your_domain_here/api/v1/api_keys/{key}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/{key}' \
-H 'Content-Type: application/json' \
-d '{
"key": "string",
"name": "string",
"policyId": "string"
}'Response
application/json
{ "apiKey": { "key": "string", "name": "string", "createdOn": "string", "lastUsedOn": "string", "policy": { … } } }
- Mock server https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/{key}
- Localhost http://localhost:5000/api/v1/api_keys/{key}
- Custom Domain https://your_domain_here/api/v1/api_keys/{key}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/api_keys/{key}'Response
application/json
{ "apiKeyDeleted": true }