schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
schema-project.json
dns
Project-wide DNS setup.
{}
schema-project.json
state
Project-wide state source.
{}
schema-project.json
secrets
Project-wide secrets provider.
{}
schema-project.json
dependencies
Project-wide dependencies to provision.
{}
schema-project.json
monitoring
Project monitoring setup.
{}
schema-project.json
plugins
Project-wide plugins.
{"type": "array", "items": {}}
schema-project.json
defaults
Project-wide default app settings.
{}
schema-project.json
ssl
SSL configuration.
{}
schema-project.json
cert_file
Public key file path. Required to be in PEM format.
{"type": "string"}
schema-project.json
key_file
Private key file path. Required to be in PEM format.
{"type": "string"}
schema-project.json
cert
Public key value in PEM format.
{"type": "string"}
schema-project.json
key
Private key value in PEM format.
{"type": "string"}
schema-project.json
type
State type, plugin specific value e.g. 'gcp' for gcp plugin or use 'local' for local state.
{"type": "string"}
schema-project.json
path
Path of local state, used only when state type is 'local'.
{"type": "string"}
schema-project.json
type
Secrets provider type, plugin specific value e.g. 'gcp' for gcp plugin.
{"type": "string"}
schema-project.json
type
The type of the dependency.
{"type": "string"}
schema-project.json
deploy
Deploy config.
{}
schema-project.json
run
Run config.
{}
schema-project.json
versioning
Enables versioning for objects.
{"type": "boolean"}
schema-project.json
location
Specify location for storage, refer to cloud provider docs for possible options.
{"type": "string"}
schema-project.json
public
Makes whole storage public so that all objects can be accessed.
{"type": "boolean"}
schema-project.json
max_versions
Maximum amount of versions to keep.
{"type": "integer"}
schema-project.json
delete_in_days
Delete new objects after X days.
{"type": "integer"}
schema-project.json
expire_versions_in_days
Expire archived versions after X days.
{"type": "integer"}
schema-project.json
cors
CORS settings.
{"type": "array", "items": {}}
schema-project.json
version
Specify version of database, refer to cloud provider docs for possible options.
{"type": "string"}
schema-project.json
high_availability
Makes database highly available meaning it will have a read replica available in case of master failure.
{"type": "boolean"}
schema-project.json
tier
Specify tier of database, refer to cloud provider docs for possible options.
{"type": "string"}
schema-project.json
flags
Database flags, refer to cloud provider docs for possible options.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-project.json
users
Database users.
{"type": "object", "additionalProperties": {}}
schema-project.json
password
Explicitly set password, defaults to a randomly generated string.
{"type": "string"}
schema-project.json
hostname
Hostname that user is allowed to connect from. Not all databases may support it.
{"type": "string"}
schema-project.json
origins
The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
{"type": "array", "items": {"type": "string"}}
schema-project.json
methods
The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
{"type": "array", "items": {"type": "string"}}
schema-project.json
response_headers
The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
{"type": "array", "items": {"type": "string"}}
schema-project.json
max_age_in_seconds
The value in seconds to return in the Access-Control-Max-Age header used in preflight responses.
{"type": "integer"}
schema-project.json
plugin
Monitoring plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-project.json
channels
Monitoring notification channels.
{"type": "array", "items": {}}
schema-project.json
targets
Monitoring targets.
{"type": "array", "items": {}}
schema-project.json
type
Notification channel type. Possible values: slack, email.
{"type": "string", "enum": ["slack", "email"]}
schema-project.json
token
Bot user oauth token used for slack notification.
{"type": "string"}
schema-project.json
channel
Channel used for slack notification.
{"type": "string"}
schema-project.json
email
Email used for email channel type.
{"type": "string"}
schema-project.json
url
Target full url.
{"type": "string"}
schema-project.json
frequency
Check frequency in minutes. Defaults to 5 minutes.
{"type": "integer", "enum": [1, 5, 10, 15]}
schema-project.json
locations
Check locations to use. Defaults to 'all'.
{"type": "array", "items": {"type": "string"}}
schema-project.json
deploy
Deploy config.
{}
schema-project.json
dns
DNS config.
{}
schema-project.json
run
Run config.
{}
schema-project.json
plugin
Deploy plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-project.json
env
Additional environment variables added to every app that supports environment variables.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-project.json
plugin
DNS plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-project.json
plugin
Run plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-project.json
env
Additional environment variables added to every app that supports environment variables.
{"type": "object", "additionalProperties": {"type": "string"}}
airlock-microgateway-3.2.json
enabled
Enable this default header action
{"type": ["boolean", "null"]}
airlock-microgateway-3.2.json
name
Name of the default header action
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
apache
Expert settings for the Apache httpd.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
security_gate
Expert settings for the Security Gate.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
ignore_case
Whether to ignore case.
{"type": "boolean", "default": "true"}
airlock-microgateway-3.2.json
inverted
Whether to invert the match.
{"type": "boolean", "default": "false"}
airlock-microgateway-3.2.json
pattern
A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use ".*"
{"type": "string"}
airlock-microgateway-3.2.json
regex
The regular expression, which matches the parts which should be rewritten.
{}
airlock-microgateway-3.2.json
substitution
The rewrite expression.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
ignore_case
Whether to ignore case.
{"type": "boolean", "default": "true"}
airlock-microgateway-3.2.json
pattern
A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use ".*"
{"type": "string"}
airlock-microgateway-3.2.json
name
A pattern for the header name.
{}
airlock-microgateway-3.2.json
value
A pattern for the header value.
{}
airlock-microgateway-3.2.json
name
A pattern for the header name.
{}
airlock-microgateway-3.2.json
replace
A string to rewrite the header value with. Can make back-references to the header value pattern.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
value
A pattern for the header value.
{}
airlock-microgateway-3.2.json
name
The name of the header to add.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
value
The value of the header to add.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
pattern
The actual pattern.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
audittoken
If the 'sub' claim should be extracted from the JWT and be used as audit token of the current session
{"type": ["boolean", "null"], "default": "false"}
airlock-microgateway-3.2.json
claims
All specified claims are checked and must match the claim's value of the decoded token. If a claim is an array, at least one entry must match the specified regex.
{"type": "array", "items": {"type": "object", "properties": {"claim": {"type": ["string", "null"]}, "regex": {"allOf": [{}, {}]}}, "additionalProperties": false}}
airlock-microgateway-3.2.json
claim
The name of the claim you want to restrict.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
regex
The regular expression that must match the value of the specified claim name.
{}
airlock-microgateway-3.2.json
expiry_checked
If the JWT standard claims expiry (exp) and not before (nbf) will be checked and must be valid.
{"type": ["boolean", "null"], "default": "false"}
airlock-microgateway-3.2.json
extraction
How the token should be extracted.
{"type": ["object", "null"], "properties": {"cookie": {"type": ["string", "null"]}, "header": {"allOf": [{}, {}]}, "mode": {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["header", "parameter", "cookie"]}], "default": "header"}, "parameter": {"type": ["string", "null"]}}, "additionalProperties": false}
airlock-microgateway-3.2.json
cookie
From which cookie the token should be extracted.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
header
How the token should be extracted from the request headers.
{}
airlock-microgateway-3.2.json
mode
From which part of the request the token should be extracted. Possible values are 'header', 'parameter', 'cookie'.
{"anyOf": [{"type": "null"}, {"type": "string", "enum": ["header", "parameter", "cookie"]}], "default": "header"}
airlock-microgateway-3.2.json
parameter
From which query parameter the token should be extracted.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
jwks_providers
List of JWKS service providers referenced by their name. Can be local or remote providers.
{"type": "array", "items": {"type": "string"}}
airlock-microgateway-3.2.json
mandatory
If disabled, requests without a token are accepted. However, if a token is present,it is extracted and validated and the configured restrictions and role extractions are applied.
{"type": ["boolean", "null"], "default": "false"}
airlock-microgateway-3.2.json
roles
Specifies which roles should be extracted from the claims.
{"type": "array", "items": {"type": "object", "properties": {"claim": {"type": ["string", "null"]}, "extraction": {"allOf": [{}, {}]}, "token_lifetime": {"type": ["boolean", "null"], "default": "false"}}, "additionalProperties": false}}
airlock-microgateway-3.2.json
claim
Name of the claim you want to extract a role from.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
extraction
The regular expression to match the role extraction and the rewrite expression of the role.
{}
airlock-microgateway-3.2.json
token_lifetime
If enabled, the expiry claim (exp) of the JWT will be used as the role lifetime.
{"type": ["boolean", "null"], "default": "false"}
airlock-microgateway-3.2.json
signature_mandatory
Enforce a signed JWT
{"type": ["boolean", "null"], "default": "true"}
airlock-microgateway-3.2.json
skew
The allowed skew when checking expiry / not before in seconds.
{"type": ["integer", "null"], "default": "10"}
airlock-microgateway-3.2.json
tech_client_id_claim
The claim to extract the technical client id from.
{"type": ["string", "null"]}
airlock-microgateway-3.2.json
content_type
A pattern to match the content type for this allow rule.
{}
airlock-microgateway-3.2.json
enabled
Enable the allow rule.
{"type": "boolean", "default": "true"}
airlock-microgateway-3.2.json
log_only
Whether to log requests not matching this allow rule instead of blocking them.
{"type": "boolean", "default": "false"}
airlock-microgateway-3.2.json
method
A pattern to match the http method for this allow rule.
{}
airlock-microgateway-3.2.json
name
Unique name for the allow rule. If omitted, a unique name will be generated. To enable/disable the default allow rule or one from a mapping_template_file, use the same name.
{"type": "string", "default": "Allow all"}
airlock-microgateway-3.2.json
path
A pattern to match the path.
{}
airlock-microgateway-3.2.json
json_content_type
JSON objects are parsed only if their content-type matches the specified pattern.
{"default": "json"}
airlock-microgateway-3.2.json
openapi
The specification to validate against.
{"type": ["object", "null"], "properties": {"log_only": {"type": ["boolean", "null"], "default": "false"}, "path_matching": {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["client_view", "backend_view"]}], "default": "client_view"}, "response_validation": {"type": ["boolean", "null"], "default": "false"}, "spec": {"type": ["string", "null"]}, "spec_file": {"type": ["string", "null"], "default": "/config/openapi.json"}}, "additionalProperties": false}