CloudTruth Backup API
The backup API from CloudTruth — 1 operation(s) for backup.
The backup API from CloudTruth — 1 operation(s) for backup.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cloudtruth:cloudtruth-backup-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: CloudTruth Management Backup 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: Backup
paths:
/api/v1/backup/snapshot/:
post:
operationId: backup_snapshot_create
summary: Get a snapshot of all Projects with parameters
tags:
- Backup
security:
- JWTAuth: []
- ApiKeyAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BackupDataSnapshot'
description: ''
components:
schemas:
BackupDataSnapshot:
type: object
description: Environment, parameter-type, and project (including parameters and values) data at a point in time.
properties:
environments:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupEnvironment'
types:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupParameterType'
projects:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupProject'
timestamp:
type: string
format: date-time
required:
- environments
- projects
- timestamp
- types
BackupProject:
type: object
description: Environment, parameter-type, and project (including parameters and values) data at a point in time.
properties:
parameters:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupParameter'
templates:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupTemplate'
name:
type: string
parent:
type:
- string
- 'null'
description:
type:
- string
- 'null'
required:
- name
- parameters
- templates
BackupExternalReference:
type: object
description: External reference data at a point in time.
properties:
fqn:
type: string
jmes_path:
type:
- string
- 'null'
required:
- fqn
BackupTemplate:
type: object
description: Template data at a given point in time.
properties:
name:
type: string
text:
type: string
description:
type:
- string
- 'null'
required:
- description
- name
- text
BackupParameterRule:
type: object
description: Rule that is applied to a parameter or parameter-type at a point in time.
properties:
rule_type:
type: string
constraints:
type: array
items:
type: string
required:
- constraints
- rule_type
BackupParameterValue:
type: object
description: Parameter value data at a point in time.
properties:
external:
allOf:
- $ref: '#/components/schemas/BackupExternalReference'
environment:
type: string
evaluated:
type: boolean
source:
type:
- string
- 'null'
project:
type:
- string
- 'null'
value:
type:
- string
- 'null'
raw:
type:
- string
- 'null'
required:
- environment
- evaluated
- external
BackupParameterType:
type: object
description: Parameter type (and rule) data at a point in time.
properties:
rules:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupParameterRule'
name:
type: string
parent:
type: string
description:
type:
- string
- 'null'
required:
- name
- parent
- rules
BackupParameter:
type: object
description: Parameter, rule, and value data at a point in time.
properties:
rules:
type: object
additionalProperties:
$ref: '#/components/schemas/BackupParameterRule'
values:
type: object
additionalProperties:
allOf:
- $ref: '#/components/schemas/BackupParameterValue'
name:
type: string
param_type:
type: string
project:
type: string
secret:
type: boolean
description:
type:
- string
- 'null'
required:
- name
- param_type
- project
- rules
- secret
- values
BackupEnvironment:
type: object
description: Basic environment data at a point in time.
properties:
name:
type: string
parent:
type:
- string
- 'null'
description:
type:
- string
- 'null'
required:
- name
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/