GitHubAppSettingsRead

Fields

The deployment's GitHub App. Secrets are never returned, only whether they are set.

5 fields

app_id

string or null

configured

boolean

private_key_set

boolean

slug

string or null

webhook_secret_set

boolean

Raw schema (JSON)

{
  "description": "W19 INT-06: the deployment's GitHub App. Secrets are never returned, only whether they are set.",
  "properties": {
    "app_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "App Id"
    },
    "configured": {
      "default": false,
      "title": "Configured",
      "type": "boolean"
    },
    "private_key_set": {
      "default": false,
      "title": "Private Key Set",
      "type": "boolean"
    },
    "slug": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Slug"
    },
    "webhook_secret_set": {
      "default": false,
      "title": "Webhook Secret Set",
      "type": "boolean"
    }
  },
  "title": "GitHubAppSettingsRead",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/settings/github-app — Get Github App Settings
• PUT /api/v1/settings/github-app — Put Github App Settings

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON