Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: CloudTruth Management Features API
version: v1
description: CloudTruth centralizes your configuration parameters and secrets making them easier to manage and use as a team.
contact:
name: CloudTruth Support
email: support@cloudtruth.com
tags:
- name: Features
paths:
/api/v1/features/:
get:
operationId: features_retrieve
description: Returns a dictionary of features and whether or not they are enabled
tags:
- Features
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturesResponse'
description: ''
summary: Features retrieve
x-summary-source: derived
components:
schemas:
FeaturesResponse:
type: object
properties:
self_hosted:
type: boolean
aws_integration:
type: boolean
azure_integration:
type: boolean
github_integration:
type: boolean
required:
- aws_integration
- azure_integration
- github_integration
- self_hosted
securitySchemes:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
description: "\nUse your CloudTruth API Key to authenticate to the API. You can get\nan API Key by creating a Service Account. During setup of the Service\nAccount you will generate a long-lived API key intended for use by automation\nand API clients. Access through the service account will be audited separately\nfrom any other user.\n\nIf you are just trying to use the API in a normal workflow, this is likely the\nauthentication mechanism you want to use.\n\nTo use the API Key, place your API Key in the Authorization header as 'Api-Key APIKEY', where\nAPIKEY is your CloudTruth API Key. For example:\n\n Authorization: Api-Key fskur.ghlsiudhrg84so938r5u\n "
JWTAuth:
in: header
name: Authorization
type: apiKey
description: "\nUse your JWT to authenticate to the API. This is how the CloudTruth\nWeb UI authenticates to the backend. It requires a user to have already logged in\nand gotten a JWT from the login process. This is usually done by an Auth0 authentication\nflow from one of the Auth0 javascript libraries. Alternatively, you can pull the\nJWT from your browser if you have a logged in session with the CloudTruth UI.\n\nThis authentication mechanism is intended for deeper integrations into the CloudTruth\nsystem, where you want to handle the user logins directly in your application. For\nnormal API use, you likely want the Api-Key authentication header and not this one.\n\nTo use the JWT, place your JWT in the Authorization header as 'Bearer JWT', where\nJWT is your JWT. For example:\n\n Authorization: Bearer eyJhbGciOiJIkuydfy.eyJzdWIiOiIxMjM....\n "
tokenAuth:
type: http
scheme: bearer
externalDocs:
url: https://docs.cloudtruth.com/