CloudTruth · Schema
Parameter
A single parameter inside of a project.
CompanyConfigManagementDevOpsCloudSecurity
Properties
| Name | Type | Description |
|---|---|---|
| url | string | The parameter url. |
| id | string | |
| ledger_id | string | |
| name | string | The parameter name. |
| description | string | |
| secret | boolean | |
| type | string | The type of this Parameter. If not provided, this will default to a string for Parameters that are not overrides or to the overridden Parameter's type for Parameters that are overrides. |
| rules | array | Rules applied to this parameter. |
| project | string | The project url. |
| project_name | string | The project name that the parameter is within. |
| referencing_templates | array | Templates that reference this Parameter. This field is not valid for history requests. |
| referencing_values | array | Dynamic values that reference this Parameter. This field is not valid for history requests. |
| values | object | This dictionary has keys that correspond to environment urls, and values that correspond to the effective value for this parameter in that environment. Each parameter has an effective value in every e |
| values_flat | array | Identical to values, except the dictionary is flattened to a list. Note that in this case, the environment in the Value is the environment asked for, not the environment where it was obtained. |
| overrides | stringnull | If this parameter's project depends on another project which provides a parameter of the same name, this parameter overrides the one provided by the dependee. You can use this field to determine if th |
| created_at | string | |
| modified_at | stringnull | |
| expires | stringnull | |
| expiration_action | object | |
| expired_status | objectnull | If this parameter expires, the status of the last attempt to handle its expiration |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/cloudtruth/main/json-schema/cloudtruth-parameter-schema.json",
"title": "Parameter",
"description": "A single parameter inside of a project.",
"x-generated": "2026-10-09",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/cloudtruth-openapi.yml#/components/schemas/Parameter",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The parameter url."
},
"id": {
"type": "string",
"readOnly": true
},
"ledger_id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "The parameter name."
},
"description": {
"type": "string"
},
"secret": {
"type": "boolean",
"readOnly": true
},
"type": {
"type": "string",
"description": "\n The type of this Parameter. If not provided, this will default to\n a string for Parameters that are not overrides or to the overridden\n Parameter's type for Parameters that are overrides.\n "
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/ParameterRule"
},
"readOnly": true,
"description": "Rules applied to this parameter."
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The project url."
},
"project_name": {
"type": "string",
"readOnly": true,
"description": "The project name that the parameter is within."
},
"referencing_templates": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true,
"description": "Templates that reference this Parameter. This field is not valid for history requests."
},
"referencing_values": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true,
"description": "Dynamic values that reference this Parameter. This field is not valid for history requests."
},
"values": {
"type": "object",
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/Value"
}
],
"nullable": true
},
"readOnly": true,
"description": "\n This dictionary has keys that correspond to environment urls, and values\n that correspond to the effective value for this parameter in that environment.\n Each parameter has an effective value in every environment based on\n project dependencies and environment inheritance.\n\n The effective value is found by looking (within the keyed environment) up\n the project dependencies by parameter name. If a value is not found, the\n parent environment is consulted with the same logic to locate a value. It\n is possible for there to be a `null` value record for an environment, which\n means there is no value set; it is also possible for there to be a value record\n with a `value` of `null`, which means the value was explicitly set to `null`.\n\n If the value's parameter does not match the enclosing parameter (holding the\n values array) then that value is flowing in through project dependencies.\n Clients must recognize this in case the user asks to modify the value; in this\n case the client must POST a new Value to the current parameter to override the\n value coming in from the project dependency.\n\n If the Value.environment matches the key, then it is an explicit value set for\n that environment. If they differ, the value was obtained from a parent\n environment (directly or indirectly). If the value is None then no value has\n ever been set in any environment for this parameter within all the project\n dependencies.\n "
},
"values_flat": {
"type": "array",
"items": {
"$ref": "#/$defs/Value"
},
"readOnly": true,
"description": "\n Identical to values, except the dictionary is flattened to a list.\n Note that in this case, the environment in the Value is the environment\n asked for, not the environment where it was obtained.\n "
},
"overrides": {
"type": [
"string",
"null"
],
"format": "uri",
"readOnly": true,
"description": "If this parameter's project depends on another project which provides a parameter of the same name, this parameter overrides the one provided by the dependee. You can use this field to determine if there will be side-effects the user should know about when deleting a parameter. Deleting a parameter that overrides another one due to an identical name will uncover the one from the dependee project."
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true
},
"expires": {
"type": [
"string",
"null"
]
},
"expiration_action": {
"nullable": true
},
"expired_status": {
"type": [
"object",
"null"
],
"additionalProperties": {},
"readOnly": true,
"description": "If this parameter expires, the status of the last attempt to handle its expiration"
}
},
"required": [
"created_at",
"expired_status",
"id",
"ledger_id",
"modified_at",
"name",
"overrides",
"project",
"project_name",
"referencing_templates",
"referencing_values",
"rules",
"secret",
"url",
"values",
"values_flat"
],
"$defs": {
"OperationEnum": {
"enum": [
"create",
"read",
"update",
"delete"
],
"type": "string",
"description": "* `create` - Create\n* `read` - Read\n* `update` - Update\n* `delete` - Delete"
},
"ParameterRule": {
"type": "object",
"description": "A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead\nof primary key relationships. Specifically:\n\n* A 'url' field is included instead of the 'id' field.\n* Relationships to other instances are hyperlinks, instead of primary keys.\n\nNOTE: this only works with DRF 3.1.0 and above.",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL for the parameter rule."
},
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"ledger_id": {
"type": "string",
"readOnly": true,
"description": "Deprecated. A UUID string identifying this parameter rule."
},
"parameter": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The parameter this rule is for."
},
"type": {
"$ref": "#/$defs/ParameterRuleTypeEnum"
},
"constraint": {
"type": "string",
"description": "The constraint for the rule. Provided for backwards compatibility."
},
"constraints": {},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true
}
},
"required": [
"created_at",
"id",
"ledger_id",
"modified_at",
"parameter",
"type",
"url"
]
},
"ParameterRuleTypeEnum": {
"enum": [
"min",
"max",
"min_len",
"max_len",
"regex",
"one_of"
],
"type": "string",
"description": "* `min` - minimum\n* `max` - maximum\n* `min_len` - minimum_length\n* `max_len` - maximum_length\n* `regex` - regex\n* `one_of` - one_of"
},
"TaskStep": {
"type": "object",
"description": "Each task detail documents the synchronization of a single\nvalue through an integration.",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "Unique identifier for a task step."
},
"operation": {
"allOf": [
{
"$ref": "#/$defs/OperationEnum"
}
],
"nullable": true,
"description": "The operation performed, if any.\n\nWhen the operation is an update, there may be additional details in the success_detail field to describe the change.\n\nWhen the project is filled in but the environment and parameterare not, the operation is on the project. When the environmentis filled in but the project and parameter are not, the operationis on the environment. When the project and parameter are filledin but the environment is not, the operation is on the parameter.When all three are filled in, the operation is on the value ofthe parameter of the project in the specified environment.\n\n* `create` - Create\n* `read` - Read\n* `update` - Update\n* `delete` - Delete"
},
"success": {
"type": "boolean",
"description": "Indicates if the operation was successful."
},
"success_detail": {
"type": [
"string",
"null"
],
"description": "Additional details about the successful operation, if any."
},
"fqn": {
"type": [
"string",
"null"
],
"description": "The fully-qualified name (FQN) this of the value that was changed.",
"maxLength": 1024
},
"environment": {
"type": [
"string",
"null"
],
"format": "uri",
"readOnly": true,
"description": "The environment affected by this step."
},
"environment_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The environment id involved in the operation."
},
"environment_name": {
"type": [
"string",
"null"
],
"description": "The environment name involved in the operation.",
"maxLength": 256
},
"project": {
"type": [
"string",
"null"
],
"format": "uri",
"readOnly": true,
"description": "The project affected by this step."
},
"project_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The project id involved in the operation."
},
"project_name": {
"type": [
"string",
"null"
],
"description": "The project name involved in the operation.",
"maxLength": 256
},
"parameter": {
"type": [
"string",
"null"
],
"format": "uri",
"readOnly": true,
"description": "The parameter affected by this step."
},
"parameter_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "The parameter id involved in the operation."
},
"parameter_name": {
"type": [
"string",
"null"
],
"description": "The parameter name involved in the operation.",
"maxLength": 256
},
"venue_id": {
"type": [
"string",
"null"
],
"description": "The integration-native id for the resource.",
"maxLength": 2048
},
"venue_name": {
"type": [
"string",
"null"
],
"description": "The name of the item or resource as known by the integration.",
"maxLength": 1024
},
"summary": {
"type": [
"string",
"null"
],
"description": "The summary of this step (what it was trying to do)."
},
"error_code": {
"type": [
"string",
"null"
],
"description": "An error code, if not successful.",
"maxLength": 256
},
"error_detail": {
"type": [
"string",
"null"
],
"description": "Details on the error that occurred during processing."
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true
}
},
"required": [
"created_at",
"environment",
"id",
"modified_at",
"parameter",
"project",
"success",
"url"
]
},
"Value": {
"type": "object",
"description": "A value for a parameter in a given environment.",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The value url."
},
"id": {
"type": "string",
"readOnly": true
},
"ledger_id": {
"type": "string",
"readOnly": true
},
"active_environment": {
"type": "string",
"readOnly": true,
"description": "The active environment this Value is viewed under"
},
"active_environment_id": {
"type": "string",
"readOnly": true,
"description": "The active environment id this Value is viewed under"
},
"active_environment_name": {
"type": "string",
"readOnly": true,
"description": "The name of the environment that this environment is viewed under"
},
"environment": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The environment this value is set in."
},
"environment_id": {
"type": "string",
"readOnly": true,
"description": "The environment id for this value."
},
"environment_name": {
"type": "string",
"readOnly": true,
"description": "The environment name for this value. This is a convenience to avoid another query against the server to resolve the environment url into a name."
},
"parameter": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The parameter this value is for."
},
"parameter_id": {
"type": "string",
"readOnly": true,
"description": "The parameter id for this value."
},
"external": {
"type": "boolean"
},
"external_fqn": {
"type": "string"
},
"external_filter": {
"type": [
"string",
"null"
]
},
"external_error": {
"type": [
"string",
"null"
],
"readOnly": true,
"description": "This field is deprecated and unused."
},
"external_status": {
"allOf": [
{
"$ref": "#/$defs/TaskStep"
}
],
"readOnly": true,
"nullable": true,
"description": "The most recent mapped pull status for an external value."
},
"internal_value": {
"type": [
"string",
"null"
]
},
"interpolated": {
"type": "boolean"
},
"value": {
"type": [
"string",
"null"
],
"description": "This is the actual content of the Value for the given parameter in the given environment.\n\nIf you request secret masking, no secret content will be included in the result and instead a series of asterisks will be used instead for the value.\n\nClients applying this value to a shell environment should set `<parameter_name>=<value>` even if `value` is the empty string. If `value` is `null`, the client should unset that shell environment variable.",
"readOnly": true
},
"evaluated": {
"type": "boolean",
"readOnly": true,
"description": "If true, the `value` field has undergone template evaluation."
},
"secret": {
"type": [
"boolean",
"null"
],
"readOnly": true,
"description": "Indicates the value content is a secret. Normally this is `true` when the parameter is a secret. It is possible for a parameter to be a secret with a external value that is not a secret. It is not possible to convert a parameter from a secret to a non-secret if any of the values are external and a secret. Clients can check this condition by leveraging this field. It is also possible for a parameter to not be a secret but for this value to be dynamic and reference a Parameter that is a secret. In this case, we indicate the value is a secret."
},
"referenced_projects": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"readOnly": true,
"description": "The projects this value references, if dynamic. This field is not valid for history requests."
},
"referenced_parameters": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"readOnly": true,
"description": "The parameters this value references, if dynamic. this field is not valid for history requests."
},
"referenced_templates": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"readOnly": true,
"description": "The templates this value references, if dynamic. This field is not valid for history requests."
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true
}
},
"required": [
"active_environment",
"active_environment_id",
"active_environment_name",
"created_at",
"environment",
"environment_id",
"environment_name",
"evaluated",
"expires_at",
"external_error",
"external_status",
"id",
"ledger_id",
"modified_at",
"parameter",
"parameter_id",
"referenced_parameters",
"referenced_projects",
"referenced_templates",
"secret",
"url",
"value"
]
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cloudtruth-parameter"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.