IntegrationsConfigUpdate

Fields

Payload for updating integrations. None = keep existing.

23 fields

github_repo: string or null
github_token: string or null
jira_api_token: string or null
jira_default_project_key: string or null
jira_domain: string or null
jira_email: string or null
jira_enabled: boolean or null
ocp_api_url: string or null
ocp_default_namespace: string or null
ocp_enabled: boolean or null
ocp_sa_token: string or null
prometheus_base_url: string or null
prometheus_bearer_token: string or null
prometheus_enabled: boolean or null
prometheus_metric_templates: array of PrometheusMetricTemplateIn or null
slack_default_channel: string or null
slack_enabled: boolean or null
slack_webhook_url: string or null
splunk_api_token: string or null
splunk_base_url: string or null
splunk_enabled: boolean or null
teams_enabled: boolean or null
teams_webhook_url: string or null

Raw schema (JSON)

{
  "description": "Payload for updating integrations. None = keep existing.",
  "properties": {
    "github_repo": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Github Repo"
    },
    "github_token": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Github Token"
    },
    "jira_api_token": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Api Token"
    },
    "jira_default_project_key": {
      "anyOf": [
        {
          "maxLength": 50,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Default Project Key"
    },
    "jira_domain": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Domain"
    },
    "jira_email": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Email"
    },
    "jira_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Jira Enabled"
    },
    "ocp_api_url": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ocp Api Url"
    },
    "ocp_default_namespace": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ocp Default Namespace"
    },
    "ocp_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ocp Enabled"
    },
    "ocp_sa_token": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ocp Sa Token"
    },
    "prometheus_base_url": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Prometheus Base Url"
    },
    "prometheus_bearer_token": {
      "anyOf": [
        {
          "maxLength": 4000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Prometheus Bearer Token"
    },
    "prometheus_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Prometheus Enabled"
    },
    "prometheus_metric_templates": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/components/schemas/PrometheusMetricTemplateIn"
          },
          "maxItems": 12,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Prometheus Metric Templates"
    },
    "slack_default_channel": {
      "anyOf": [
        {
          "maxLength": 100,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "deprecated": true,
      "title": "Slack Default Channel"
    },
    "slack_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Slack Enabled"
    },
    "slack_webhook_url": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Slack Webhook Url"
    },
    "splunk_api_token": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Splunk Api Token"
    },
    "splunk_base_url": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Splunk Base Url"
    },
    "splunk_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Splunk Enabled"
    },
    "teams_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Teams Enabled"
    },
    "teams_webhook_url": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Teams Webhook Url"
    }
  },
  "title": "IntegrationsConfigUpdate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

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

Used by schemas

No other schema contains this one.

More details

Specification: OpenAPI JSON