IntegrationsConfigRead

Fields

External integrations configuration (no tokens).

28 fields

environment_fields: array of string
github_repo · required: string or null
github_token_set · required: boolean
jira_default_project_key · required: string
jira_domain · required: string or null
jira_email · required: string or null
jira_enabled · required: boolean
jira_token_set · required: boolean
ocp_api_url · required: string or null
ocp_default_namespace · required: string
ocp_enabled · required: boolean
ocp_token_set · required: boolean
prometheus_base_url: string or null
prometheus_enabled: boolean
prometheus_metric_templates: array of PrometheusMetricTemplate
prometheus_templates_source: string
prometheus_token_set: boolean
slack_default_channel · required: string
slack_enabled · required: boolean
slack_webhook_set · required: boolean
slack_webhook_url: string or null
splunk_base_url · required: string or null
splunk_enabled · required: boolean
splunk_token_set · required: boolean
teams_enabled · required: boolean
teams_webhook_set · required: boolean
teams_webhook_url: string or null
vault_fields: array of string

Raw schema (JSON)

{
  "description": "External integrations configuration (no tokens).",
  "properties": {
    "environment_fields": {
      "items": {
        "type": "string"
      },
      "title": "Environment Fields",
      "type": "array"
    },
    "github_repo": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Github Repo"
    },
    "github_token_set": {
      "title": "Github Token Set",
      "type": "boolean"
    },
    "jira_default_project_key": {
      "title": "Jira Default Project Key",
      "type": "string"
    },
    "jira_domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Domain"
    },
    "jira_email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Email"
    },
    "jira_enabled": {
      "title": "Jira Enabled",
      "type": "boolean"
    },
    "jira_token_set": {
      "title": "Jira Token Set",
      "type": "boolean"
    },
    "ocp_api_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ocp Api Url"
    },
    "ocp_default_namespace": {
      "title": "Ocp Default Namespace",
      "type": "string"
    },
    "ocp_enabled": {
      "title": "Ocp Enabled",
      "type": "boolean"
    },
    "ocp_token_set": {
      "title": "Ocp Token Set",
      "type": "boolean"
    },
    "prometheus_base_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Prometheus Base Url"
    },
    "prometheus_enabled": {
      "default": false,
      "title": "Prometheus Enabled",
      "type": "boolean"
    },
    "prometheus_metric_templates": {
      "items": {
        "$ref": "#/components/schemas/PrometheusMetricTemplate"
      },
      "title": "Prometheus Metric Templates",
      "type": "array"
    },
    "prometheus_templates_source": {
      "default": "default",
      "title": "Prometheus Templates Source",
      "type": "string"
    },
    "prometheus_token_set": {
      "default": false,
      "title": "Prometheus Token Set",
      "type": "boolean"
    },
    "slack_default_channel": {
      "deprecated": true,
      "title": "Slack Default Channel",
      "type": "string"
    },
    "slack_enabled": {
      "title": "Slack Enabled",
      "type": "boolean"
    },
    "slack_webhook_set": {
      "title": "Slack Webhook Set",
      "type": "boolean"
    },
    "slack_webhook_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Slack Webhook Url"
    },
    "splunk_base_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Splunk Base Url"
    },
    "splunk_enabled": {
      "title": "Splunk Enabled",
      "type": "boolean"
    },
    "splunk_token_set": {
      "title": "Splunk Token Set",
      "type": "boolean"
    },
    "teams_enabled": {
      "title": "Teams Enabled",
      "type": "boolean"
    },
    "teams_webhook_set": {
      "title": "Teams Webhook Set",
      "type": "boolean"
    },
    "teams_webhook_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Teams Webhook Url"
    },
    "vault_fields": {
      "items": {
        "type": "string"
      },
      "title": "Vault Fields",
      "type": "array"
    }
  },
  "required": [
    "jira_enabled",
    "jira_domain",
    "jira_email",
    "jira_token_set",
    "jira_default_project_key",
    "splunk_enabled",
    "splunk_base_url",
    "splunk_token_set",
    "ocp_enabled",
    "ocp_api_url",
    "ocp_token_set",
    "ocp_default_namespace",
    "slack_enabled",
    "slack_webhook_set",
    "slack_default_channel",
    "teams_enabled",
    "teams_webhook_set",
    "github_repo",
    "github_token_set"
  ],
  "title": "IntegrationsConfigRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

GET /api/v1/settings/integrations — Get Integrations Config
PUT /api/v1/settings/integrations — Update Integrations Config

Used by schemas

No other schema contains this one.

More details

Specification: OpenAPI JSON